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

feat(cdk): add --project-name init option #28979

Closed
wants to merge 2 commits into from
Closed

Conversation

nmussy
Copy link
Contributor

@nmussy nmussy commented Feb 4, 2024

Issue # (if applicable)

Closes #4865.

Reason for this change

Multiple requests have been made to allow the user to change the project name on cdk init, currently set to the working directory name, to a custom value.

Description of changes

This PR documents, implements and tests a new --project-name for the cdk init CLI. Its default value is the current behavior, i.e. the working directory name.

This PR follows up my previous attempt, now stale (#4884)

Description of how you validated changes

The new CLI option is being validated by a test added in init.test.ts

Checklist


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 effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 labels Feb 4, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team February 4, 2024 09:45
@github-actions github-actions bot added the distinguished-contributor [Pilot] contributed 50+ PRs to the CDK label Feb 4, 2024
@@ -271,7 +271,8 @@ async function parseCommandLineArguments(args: string[]) {
.command('init [TEMPLATE]', 'Create a new, empty CDK project from a template.', (yargs: Argv) => yargs
.option('language', { type: 'string', alias: 'l', desc: 'The language to be used for the new project (default can be configured in ~/.cdk.json)', choices: initTemplateLanguages })
.option('list', { type: 'boolean', desc: 'List the available templates' })
.option('generate-only', { type: 'boolean', default: false, desc: 'If true, only generates project files, without executing additional operations such as setting up a git repo, installing dependencies or compiling the project' }),
.option('generate-only', { type: 'boolean', default: false, desc: 'If true, only generates project files, without executing additional operations such as setting up a git repo, installing dependencies or compiling the project' })
.option('project-name', { type: 'string', desc: 'Name of the generated project (defaults to current directory name)', requiresArg: true }),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let me know if you would also like me to describe the new option in aws-cdk/README.md, or if this --help output is sufficient

@nmussy nmussy changed the title feat(cli): add --project-name init option feat(aws-cdk): add --project-name init option Feb 4, 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.

@aws-cdk-automation aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Feb 4, 2024
@nmussy nmussy changed the title feat(aws-cdk): add --project-name init option feat(cdk): add --project-name init option Feb 4, 2024
@nmussy
Copy link
Contributor Author

nmussy commented Feb 4, 2024

Exemption Request:

  • The change is documented via the CLI --help command, but I can also add it to the aws-cdk/README.md
  • A test case was added, but not to @aws-cdk-testing, let me know if this is required given the limited nature of the change
  • This is not a breaking change
  • CLI code was indeed changed and will need to go through the pipeline

@aws-cdk-automation aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Feb 4, 2024
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@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 Feb 4, 2024
@aws-cdk-automation
Copy link
Collaborator

This PR has been in the CHANGES REQUESTED state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week.

@nmussy
Copy link
Contributor Author

nmussy commented Mar 3, 2024

I have not abandoned this PR, and am still awaiting a review

@aws-cdk-automation
Copy link
Collaborator

This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error.

@aws-cdk-automation aws-cdk-automation added the closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. label Mar 4, 2024
@paulhcsun paulhcsun reopened this Apr 8, 2024
@paulhcsun paulhcsun added pr-linter/do-not-close The PR linter will not close this PR while this label is present and removed closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. labels Apr 8, 2024
@aws-cdk-automation
Copy link
Collaborator

The pull request linter fails with the following errors:

❌ Features must contain a change to a README file.
❌ Features must contain a change to an integration test file and the resulting snapshot.
❌ Breaking changes in stable modules [cdk] is disallowed.
❌ CLI code has changed. A maintainer must run the code through the testing pipeline (git fetch origin pull/28979/head && git push -f origin FETCH_HEAD:test-main-pipeline), then add the 'pr-linter/cli-integ-tested' label when the pipeline succeeds.

PRs must pass status checks before we can provide a meaningful review.

If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing Exemption Request and/or Clarification Request.

✅ A exemption request has been requested. Please wait for a maintainer's review.

@paulhcsun paulhcsun closed this Apr 9, 2024
@nmussy
Copy link
Contributor Author

nmussy commented Apr 9, 2024

Sorry, I should have indicated that I reopened the same PR in #29695, given I couldn't reopen this one 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
distinguished-contributor [Pilot] contributed 50+ PRs to the CDK effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 pr/needs-cli-test-run This PR needs CLI tests run against it. pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. pr-linter/do-not-close The PR linter will not close this PR while this label is present pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cdk init should have option to produce new project with fixed file and class names
3 participants