Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(pkglint): rule to ensure that only allowed packages are public #11317

Merged
merged 1 commit into from
Nov 11, 2020

Conversation

nija-at
Copy link
Contributor

@nija-at nija-at commented Nov 5, 2020

In the v2 branch, most packages are private except a handful. Update the
pkglint rule to carry an allowlist on the set of packages that should be
private.

Prevents accidentally publishing new packages.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@nija-at nija-at requested a review from a team November 5, 2020 16:30
@nija-at nija-at self-assigned this Nov 5, 2020
@gitpod-io
Copy link

gitpod-io bot commented Nov 5, 2020

@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Nov 5, 2020
@nija-at nija-at added the pr/do-not-merge This PR should not be merged at this time. label Nov 5, 2020
tools/pkglint/lib/rules.ts Outdated Show resolved Hide resolved
@nija-at nija-at requested a review from a team November 5, 2020 16:54
@nija-at nija-at marked this pull request as draft November 5, 2020 17:10
@nija-at nija-at marked this pull request as ready for review November 5, 2020 17:11
@nija-at nija-at marked this pull request as draft November 5, 2020 17:14
@nija-at nija-at marked this pull request as ready for review November 5, 2020 17:15
*/
export class V2PublicPackages extends ValidationRule {
public readonly name = 'v2/public-package';
private readonly allowlist = ['aws-cdk-lib', 'cdk', 'aws-cdk', 'awslint'];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

feels like we are missing some stuff here.... decdk, cdk-dasm come to mind and more. how did we compile this list?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not the final list. it's just a start. we'll adjust as we go.

In the v2 branch, most packages are private except a handful. Update the
pkglint rule to carry an allowlist on the set of packages that should be
private.

Prevents accidentally publishing new packages.
@nija-at nija-at removed the pr/do-not-merge This PR should not be merged at this time. label Nov 11, 2020
@mergify
Copy link
Contributor

mergify bot commented Nov 11, 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).

@mergify mergify bot merged commit a70bceb into master Nov 11, 2020
@mergify mergify bot deleted the nija-at/pkglint-v2visibility branch November 11, 2020 12:39
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
  • Commit ID: 6c73a1c
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants