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

Patch to support doNotOverwrite() in SupportingFile #20543

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

robig
Copy link

@robig robig commented Jan 26, 2025

@martin-mfg In java class org.openapitools.codegen.SupportingFile exists a method named doNotOverwrite which should be used to indicate a "supporting file which should not overwrite a file of the same name.". However, I could not find an implementation of this anywhere in the Java DefaultGenerator.

This patch is simply implementing this behaviour as described in javadoc of the class I mentioned. If the file exists, and the file will be skipped and corresponding status message is set.
Feel free to modify the patch or change the logged text to a more obvious one using the right terminology.

Thank you for the great work!
Rob

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (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.

robig added 2 commits January 23, 2025 11:58
…ite option

I could not see any usage of doNotOverwrite/isCanOverwrite of SupportingFile class
@robig robig changed the title Patch which is ido not overwrite supporting file Patch to support doNotOverwrite() in SupportingFile Jan 26, 2025
@wing328
Copy link
Member

wing328 commented Jan 28, 2025

thanks for the PR. can you please add a test if possible?

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