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 template README.md (JavaScript, TypeScript) #28003

Merged
merged 2 commits into from
Nov 16, 2023

Conversation

pmeinhardt
Copy link
Contributor

@pmeinhardt pmeinhardt commented Nov 15, 2023

Use npx to run project-specific cdk, not a globally installed version.

This ensures everybody working on the project uses the same version of the command-line interface.

With the previous instructions, if anybody had cdk installed globally, e.g., via npm install --global aws-cdk or homebrew install aws-cdk, they would run that version. It seems desirable that everybody working on a CDK app uses the same version of the command-line interface, as specified in package.json (or package-lock.json).

Example:

Given a package.json which specifies "aws-cdk": "2.104.0" and a globally installed cdk, this can happen:

$ cdk --version
2.108.1 (build 2320255)

$ npx cdk --version
2.104.0 (build 3b99abe)

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

Use npx to run project-specific cdk, not a globally installed version.

This ensures everybody working on the project uses the same version of
the command-line interface.
@github-actions github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2 labels Nov 15, 2023
@aws-cdk-automation aws-cdk-automation requested a review from a team November 15, 2023 10:30
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.

@pmeinhardt pmeinhardt changed the title Update template README.md (JavaScript, TypeScript) docs: Update template README.md (JavaScript, TypeScript) Nov 15, 2023
@aws-cdk-automation aws-cdk-automation dismissed their stale review November 15, 2023 10:33

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

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Nov 15, 2023
Copy link
Contributor

mergify bot commented Nov 16, 2023

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-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Nov 16, 2023
Copy link
Contributor

mergify bot commented Nov 16, 2023

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: c2b74be
  • 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 c00b974 into aws:main Nov 16, 2023
8 of 9 checks passed
Copy link
Contributor

mergify bot commented Nov 16, 2023

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
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants