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: stop regeneration on error #19898

Merged
merged 1 commit into from
Nov 10, 2024
Merged

Conversation

joscha
Copy link
Contributor

@joscha joscha commented Oct 17, 2024

This change makes sure that the process exits and shows a non-zero exit code if any of the regeneration commands fail.

Compare:

(
echo 1
ehco 2
echo 3
)
echo "exit code: " $?
1
ehco: command not found
3
exit code: 0

vs:

(
echo 1 || exit
ehco 2 || exit
echo 3 || exit
)
echo "exit code: " $?
1
ehco: command not found
exit code: 127

I ran into this when the generation had an issue and was silently erroring, leaving the samples unregenerated. I only found out when the tests on CI failed.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    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/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request. @wing328

@wing328
Copy link
Member

wing328 commented Nov 10, 2024

thanks for the PR. let's give it a try

@wing328 wing328 merged commit 824f864 into OpenAPITools:master Nov 10, 2024
14 of 15 checks passed
@wing328 wing328 added this to the 7.10.0 milestone Nov 20, 2024
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