Skip to content

fix(cli): improve description of --json to reflect behavior#3086

Merged
eladb merged 1 commit intomasterfrom
benisrae/improve-json-doc
Jun 26, 2019
Merged

fix(cli): improve description of --json to reflect behavior#3086
eladb merged 1 commit intomasterfrom
benisrae/improve-json-doc

Conversation

@eladb
Copy link
Copy Markdown
Contributor

@eladb eladb commented Jun 26, 2019

When using cdk synth -o the templates emitted to the cloud assembly are always in JSON. This change improves the documentation for --json, which only applies when -o is not used.

Closes #2965

Please read the contribution guidelines and follow the pull-request checklist.

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

fix(cli): improve description of --json to reflect behavior
91ffd5e 
When using `cdk synth -o` the templates emitted to the cloud assembly are always in JSON. This change improves the documentation for `--json`, which only applies when `-o` is not used.

Closes #2965
@eladb eladb requested a review from a team as a code owner June 26, 2019 16:56
@ghost ghost requested a review from shivlaks June 26, 2019 16:56
@eladb eladb merged commit 68cfa54 into master Jun 26, 2019
@RomainMuller RomainMuller deleted the benisrae/improve-json-doc branch August 10, 2019 00:39
This was referenced Aug 22, 2019
Open
Open
Open
Open
Open
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 23, 2019
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Sep 23, 2019

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

  • PR title type(scope): text
    • type: fix, feat, refactor go into CHANGELOG, chore is hidden
    • scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
    • text: use all lower-case, do not end with a period, do not include issue refs
  • PR Description
    • Rationale: describe rationale of change and approach taken
    • Issues: indicate issues fixed via: fixes #xxx or closes #xxx
    • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Testing
    • Unit test added. Prefer to add a new test rather than modify existing tests
    • CLI or init templates change? Re-run/add CLI integration tests
  • Documentation
    • README: update module README to describe new features
    • API docs: public APIs must be documented. Copy from official AWS docs when possible
    • Design: for significant features, follow design process

This was referenced Dec 12, 2019
Closed
Closed
Closed
Merged
Closed
Open
Open
Open
Open
Open
Open
Open
Open
This was referenced Jan 20, 2020
Closed
Closed
@NOUIY NOUIY mentioned this pull request Sep 24, 2024
Open
This was referenced Sep 24, 2024
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
@NOUIY NOUIY mentioned this pull request Oct 2, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@RomainMuller RomainMuller RomainMuller approved these changes

@shivlaks shivlaks shivlaks approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

contribution/core This is a PR that came from AWS.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

cdk synth generates only json files when used with -o

4 participants

@eladb @RomainMuller @shivlaks @NGL321