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

fix(pkglint): allow dependencies on L1 only modules #21208

Merged
merged 3 commits into from
Jul 25, 2022
Merged

Conversation

comcalvi
Copy link
Contributor

@comcalvi comcalvi commented Jul 18, 2022

Today, pkglint prevents any module from depending on any experimental module, regardless of its maturity. This PR considers maturity such that cfn-only modules can be taken as dependencies. While writing tests for this is possible, it would be out-of-scope for this PR.


All Submissions:

Adding new Unconventional Dependencies:

  • This PR adds new unconventional dependencies following the process described here

New Features

  • Have you added the new feature to an integration test?
    • Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

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

@comcalvi comcalvi requested a review from rix0rrr July 18, 2022 16:36
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Jul 18, 2022
@gitpod-io
Copy link

gitpod-io bot commented Jul 18, 2022

@aws-cdk-automation aws-cdk-automation requested a review from a team July 18, 2022 16:36
@github-actions github-actions bot added the p2 label Jul 18, 2022
@comcalvi comcalvi added pr-linter/exempt-test The PR linter will not require test changes and removed pr-linter/exempt-test The PR linter will not require test changes labels Jul 18, 2022
if (maturity === 'cfn-only') {
return;
}

// eslint-disable-next-line @typescript-eslint/no-require-imports
const stability = require(`${dep}/package.json`).stability;
Copy link
Contributor

Choose a reason for hiding this comment

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

We should ignore stability.

  • maturity == how we feel about the reliability of the package.
  • stability == the default stability of API elements in this package (i.o.w, setting this is just syntactic sugar over putting @stable, @experimental etc in every docstring)

Copy link
Contributor

@rix0rrr rix0rrr left a comment

Choose a reason for hiding this comment

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

See previous comment

@comcalvi comcalvi requested a review from rix0rrr July 19, 2022 21:44
@comcalvi comcalvi added the pr-linter/exempt-test The PR linter will not require test changes label Jul 19, 2022
@mergify
Copy link
Contributor

mergify bot commented Jul 25, 2022

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: a1ca961
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify mergify bot merged commit f16fd69 into aws:main Jul 25, 2022
@mergify
Copy link
Contributor

mergify bot commented Jul 25, 2022

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mackalex pushed a commit to mackalex/aws-cdk that referenced this pull request Jul 30, 2022
josephedward pushed a commit to josephedward/aws-cdk that referenced this pull request Aug 30, 2022
Today, pkglint prevents any module from depending on any experimental module, regardless of its `maturity`. This PR considers `maturity` such that `cfn-only` modules can be taken as dependencies. While writing tests for this is possible, it would be out-of-scope for this PR.

----

### All Submissions:

* [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*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
Labels
contribution/core This is a PR that came from AWS. p2 pr-linter/exempt-test The PR linter will not require test changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants