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

docs: update integration test documentation #28781

Merged
merged 5 commits into from
Jan 19, 2024
Merged

docs: update integration test documentation #28781

merged 5 commits into from
Jan 19, 2024

Conversation

HBobertz
Copy link
Contributor

@HBobertz HBobertz commented Jan 19, 2024

Realized there were 2 integration test docs and the one under @aws-cdk-testing had more pragmatic steps on how to run the integration tests. Updated the docs of the other integ file to link to the readme in @aws-cdk-testing and then added a section on setup for the steps on how to build the package


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

@github-actions github-actions bot added the p2 label Jan 19, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team January 19, 2024 16:34
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Jan 19, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@HBobertz HBobertz changed the title docs(aws-cdk): Update Integration Test Documentation docs(cdk): Update Integration Test Documentation Jan 19, 2024
@HBobertz HBobertz changed the title docs(cdk): Update Integration Test Documentation docs: Update Integration Test Documentation Jan 19, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review January 19, 2024 16:38

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 19, 2024
yarn install # Install dependencies
npx lerna run build --scope=aws-cdk # Build the CDK cli
yarn build # Build the @aws-cdk-testing/cli-integ package
../../../scripts/align-version.sh # Align the versions of CDK packages
Copy link
Contributor

Choose a reason for hiding this comment

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

what is this align-versions.sh script lol. I have never run that before.

Copy link
Contributor Author

@HBobertz HBobertz Jan 19, 2024

Choose a reason for hiding this comment

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

it turns all the 0.0.0s in the package.jsons into whatever the version of the cli is so the thing doesn't panic. Some tests fail unti you do this for some reason. Unsure why

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh shit. I wish I had known this a while ago. I've been manually working around this.

Copy link
Contributor

Choose a reason for hiding this comment

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

I have never used this lol

@kaizencc kaizencc changed the title docs: Update Integration Test Documentation docs: update integration test documentation Jan 19, 2024
Copy link
Contributor

mergify bot commented Jan 19, 2024

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 aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 19, 2024
Copy link
Contributor

mergify bot commented Jan 19, 2024

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

Copy link
Contributor

mergify bot commented Jan 19, 2024

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

Comment on lines +44 to +45
npx lerna run build --scope=aws-cdk # Build the CDK cli
yarn build # Build the @aws-cdk-testing/cli-integ package
Copy link
Contributor

@mrgrain mrgrain Jan 19, 2024

Choose a reason for hiding this comment

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

I'd replace this with this:

Suggested change
npx lerna run build --scope=aws-cdk # Build the CDK cli
yarn build # Build the @aws-cdk-testing/cli-integ package
cd packages/@aws-cdk-testing/cli-integ/
../../../scripts/buildup

That's definitely re-building everything you need for integ tests and will ignore any caches.

Also I think you've missed change the directory

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 18d4095
  • 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 414c570 into main Jan 19, 2024
14 checks passed
@mergify mergify bot deleted the bobertzh/docs branch January 19, 2024 20:25
Copy link
Contributor

mergify bot commented Jan 19, 2024

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

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants