Skip to content

docs(cli): clarify app cli option#21715

Merged
mergify[bot] merged 1 commit intomainfrom
peterwoodworth/cliDocs
Aug 23, 2022
Merged

docs(cli): clarify app cli option#21715
mergify[bot] merged 1 commit intomainfrom
peterwoodworth/cliDocs

Conversation

@peterwoodworth
Copy link
Copy Markdown
Contributor

@peterwoodworth peterwoodworth commented Aug 22, 2022

The CLI documentation seen when running --help is misleading about the --app option being required. This option can be (and most often is) set by cdk.json, making the CLI option itself not strictly required when an app is needed. Additionally, no app value needs to be passed if the invoked command doesn't run the app (notably on bootstrap and context, possibly others). This PR clarifies these conditions

Fixes: #21564


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

@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented Aug 22, 2022

@github-actions github-actions bot added the p2 label Aug 22, 2022
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Aug 22, 2022
@aws-cdk-automation aws-cdk-automation requested a review from a team August 22, 2022 22:21
@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

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

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

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Aug 23, 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).

@mergify mergify bot merged commit e039b51 into main Aug 23, 2022
@mergify mergify bot deleted the peterwoodworth/cliDocs branch August 23, 2022 04:23
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.

(cdk-cli): (context says it requires --app but it doesn't)

4 participants