aws/aws-cdk

(docs): nodejs-function, document how to disable bundling for tests

Open

#12,844 opened on Feb 3, 2021

View on GitHub
 (6 comments) (7 reactions) (0 assignees)TypeScript (3,530 forks)batch import
@aws-cdk/pipelinesdocs/inlineeffort/smallfeature-requestgood first issuep2

Repository metrics

Stars
 (10,710 stars)
PR merge metrics
 (Avg merge 14d 11h) (68 merged PRs in 30d)

Description

Create an option to disable, (or automatically disable?) asset build/bundling, when using Jest to instantiate a cdk-pipeline for tests

Use Case

When using a pipeline instance in jest it causes the assets to build/bundle, it may be the intention of the test to check only that the pipeline is correctly formed, build/bundle testing may be handled else where. In this case the build/bundle process creates additional time delay on testing in synth stage of the pipeline.

Proposed Solution

Create an option to disable, (or automatically disable?) asset build/bundling, when using Jest to instantiate a cdk-pipeline for tests

Other

  • :wave: I may be able to implement this feature request
  • :warning: This feature might incur a breaking change

This is a :rocket: Feature Request

Contributor guide

Research direction
Investigate the NodejsFunction construct and its bundling options. Look for how to disable bundling in tests, then update the documentation to describe this.
Tech stack
typescriptnodejsjest
Domain
clouddevopsbuild system
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScriptAWS CDK
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75