Skip to content

chore: avoid runtime dependency between cfnspec and pkglint#17751

Merged
mergify[bot] merged 5 commits intomasterfrom
benisrae/cfnspec-pkglint-decouple
Nov 30, 2021
Merged

chore: avoid runtime dependency between cfnspec and pkglint#17751
mergify[bot] merged 5 commits intomasterfrom
benisrae/cfnspec-pkglint-decouple

Conversation

@eladb
Copy link
Copy Markdown
Contributor

@eladb eladb commented Nov 29, 2021

Our build pipeline is currently failing because cfnspec (which is a public package) takes a runtime dependency on pkglint (which is a private package). This was introduced in #17696.

To resolve this, we moved the functionality that generates new L1 library code from lib/ to build-tools/ since it's only needed in CDK build context (technically this is breaking public API, but we could not see any use case for external users to generate L1 modules in CDK-repository format).


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

Build is currently failing in the pipeline because of this.

Since `pkglint` is private, `cfnspec` (which is public) cannot take a runtime dependency to it. But we still want to generate the same README format for CFN modules, so instead we just statically copy the relevant files from pkglint during build. Ugly but works.
@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented Nov 29, 2021

@eladb eladb requested a review from rix0rrr November 29, 2021 14:39
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Nov 29, 2021
},
"dependencies": {
"@aws-cdk/cfn2ts": "0.0.0",
"@aws-cdk/pkglint": "0.0.0",
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This should be fine because ubergen is not a public package

@aws aws deleted a comment from aws-cdk-automation Nov 29, 2021
@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: 4ba17a2
  • 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 5fc0141 into master Nov 30, 2021
@mergify mergify bot deleted the benisrae/cfnspec-pkglint-decouple branch November 30, 2021 08:28
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Nov 30, 2021

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).

pedrosola pushed a commit to pedrosola/aws-cdk that referenced this pull request Dec 1, 2021
Our build pipeline is currently failing because `cfnspec` (which is a public package) takes a runtime dependency on `pkglint` (which is a private package). This was introduced in aws#17696.

To resolve this, we moved the functionality that generates new L1 library code from `lib/` to `build-tools/` since it's only needed in CDK build context (technically this is breaking public API, but we could not see any use case for external users to generate L1 modules in CDK-repository format).

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this pull request Feb 21, 2022
Our build pipeline is currently failing because `cfnspec` (which is a public package) takes a runtime dependency on `pkglint` (which is a private package). This was introduced in aws#17696.

To resolve this, we moved the functionality that generates new L1 library code from `lib/` to `build-tools/` since it's only needed in CDK build context (technically this is breaking public API, but we could not see any use case for external users to generate L1 modules in CDK-repository format).

----

*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

@aws-cdk/cfnspec contribution/core This is a PR that came from AWS.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants