chore(pkglint): dont publish cdk.out directories #8803
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rix0rrr
approved these changes
Jun 30, 2020
iliapolo
changed the title
RomainMuller
suggested changes
Jun 30, 2020
Comment on lines
+66
to
+75
| if (!npmIgnore.includes('**/cdk.out')) { | ||
| pkg.report({ | ||
| ruleName: this.name, | ||
| message: `${npmIgnorePath}: Must exclude **/cdk.out`, | ||
| fix: () => fs.writeFileSync( | ||
| npmIgnorePath, | ||
| `${npmIgnore}\n# exclude cdk artifacts\n**/cdk.out` | ||
| ) | ||
| }); | ||
| } |
There was a problem hiding this comment.
No need to prefix with **/, and only ignore if it is a directory:
Suggested change
| if (!npmIgnore.includes('**/cdk.out')) { | |
| pkg.report({ | |
| ruleName: this.name, | |
| message: `${npmIgnorePath}: Must exclude **/cdk.out`, | |
| fix: () => fs.writeFileSync( | |
| npmIgnorePath, | |
| `${npmIgnore}\n# exclude cdk artifacts\n**/cdk.out` | |
| ) | |
| }); | |
| } | |
| if (!npmIgnore.includes('cdk.out/')) { | |
| pkg.report({ | |
| ruleName: this.name, | |
| message: `${npmIgnorePath}: Must exclude cdk.out/`, | |
| fix: () => fs.writeFileSync( | |
| npmIgnorePath, | |
| `${npmIgnore}\n# exclude cdk artifacts\ncdk.out/` | |
| ) | |
| }); | |
| } |
There was a problem hiding this comment.
@RomainMuller Are you sure about the **/?
This is npm pack output without it:
❯ npm pack
npm notice
npm notice 📦 @aws-cdk/aws-batch@0.0.0
npm notice === Tarball Contents ===
npm notice 193.3kB .jsii
npm notice 0 test/cdk.out/file
npm notice 0 test/nested/cdk.out/hello
npm notice 11.4kB LICENSE
npm notice 113B NOTICE
....
....
aws-cdk-aws-batch-0.0.0.tgzAnd this is with it:
❯ npm pack
npm notice
npm notice 📦 @aws-cdk/aws-batch@0.0.0
npm notice === Tarball Contents ===
npm notice 193.3kB .jsii
npm notice 11.4kB LICENSE
npm notice 113B NOTICE
....
....
aws-cdk-aws-batch-0.0.0.tgzNotice the first two lines. Am I missing something?
There was a problem hiding this comment.
Oh fuck this is npmIgnore, not gitignore! Sorry this is PEBCAK.
RomainMuller
approved these changes
Jun 30, 2020
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
iliapolo
added a commit
that referenced
this pull request
Jun 30, 2020
Adds a pkglint validation so that we always include `**/cdk.out` in our `.npmignore` files. This will prevent us from accidentally publishing cdk artifacts that were generated during build/test. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
shivlaks
added a commit
that referenced
this pull request
Oct 14, 2020
…g missing libraries this change was introduced in #8803 but the script to create missing construct libraries was not updated. As a follow-up, will look into creating a test that exercises creation of a new construct library and the subsequent validation against pkglint.
mergify bot
pushed a commit
that referenced
this pull request
Oct 14, 2020
…g missing libraries (#10876) this change was introduced in #8803 but the script to create missing construct libraries was not updated. As a follow-up, will look into creating a test that exercises creation of a new construct library and the subsequent validation against pkglint. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a pkglint validation so that we always include
**/cdk.outin our.npmignorefiles. This will prevent us from accidentally publishing cdk artifacts that were generated during build/test.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license