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

Update documentation with global propperty #6863

Merged
merged 4 commits into from
Jul 5, 2020
Merged

Update documentation with global propperty #6863

merged 4 commits into from
Jul 5, 2020

Conversation

wing328
Copy link
Member

@wing328 wing328 commented Jul 5, 2020

  • replace -D with --global-property
  • update bin scripts with ./bin/generate-samples.sh

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project beforehand.
  • Run the shell script ./bin/generate-samples.shto update all Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/config/java*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

@wing328
Copy link
Member Author

wing328 commented Jul 5, 2020

FYI. @jimschubert

@wing328 wing328 merged commit 47b7a0d into master Jul 5, 2020
Copy link
Member

@jimschubert jimschubert left a comment

Choose a reason for hiding this comment

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

Left a comment, but it applies to multiple changes here


```sh
# generate only models
java -Dmodels {opts}
--global-property models
Copy link
Member

Choose a reason for hiding this comment

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

@wing328 this charge isn't correct. The syntax in the README is system properties, and value-less properties like models/APIs can only be passed as system properties like exist in the README.

To change to our CLI args, any occurrence must follow the generate CLI command and must have key=value syntax.

The reason our -D option was removed from CLI is because people mistakenly thought this worked in any position and modified system properties similar to the mvn app. Even I was confused by this when I began contributing.

Copy link
Member Author

Choose a reason for hiding this comment

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

@jimschubert Let's not advertise the usage of -D (any position), shall we? The main reason is what you've pointed out - confusing.

@wing328 wing328 deleted the update-readme branch July 5, 2020 15:19
jimschubert added a commit that referenced this pull request Jul 7, 2020
* master:
  Remove jimschubert from C# technical committee (#6865)
  Add Mock Server client modification feature (#6747)
  Update documentation with global propperty (#6863)
  [haskell-http-client] avoid depending on ParseTime,FormatTime (#6861)
  Update docker-tag-latest-release.yml
@wing328 wing328 added this to the 5.0.0 milestone Aug 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants