Skip to content

Conversation

@sir4ur0n
Copy link
Contributor

@sir4ur0n sir4ur0n commented Aug 25, 2025

Fixes #21806

I checked that CI correctly fails if the generated code is not formatted, see https://github.com/OpenAPITools/openapi-generator/actions/runs/17209423214/job/48817282401?pr=21809

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 WSL)
    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 solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@sir4ur0n sir4ur0n changed the title [OCaml] Generate .ocamlformat file [OCaml] Generate .ocamlformat file; format all generated OCaml files Aug 25, 2025
@sir4ur0n
Copy link
Contributor Author

@wing328 I gave it a shot, and tried to format the generated files + check that in CI.
However this makes the CI job OpenAPI Generator / Samples up-to-date (pull_request) fail because it re-generates (thus not-formatted) then obviously fails.

What do you suggest?
Worse case scenario I can undo the whole formatting + checking in CI but it feels like a shame 😞
Another solution would be to add formatting between Generate samples and Verify git status steps, but I'm not sure if you want to follow that route.

@wing328
Copy link
Member

wing328 commented Aug 25, 2025

However this makes the CI job OpenAPI Generator / Samples up-to-date (pull_request) fail because it re-generates (thus not-formatted) then obviously fails.

that's expected. the same applies to other client samples that we previously tried to auto-format the code.

so no need to commit the auto-format code

the .ocamlformat file should make it easier for users to format the code if needed (some users simply don't care about the code format as long as the auto-generated ocam client is functional)

@sir4ur0n sir4ur0n marked this pull request as ready for review August 25, 2025 15:55
@sir4ur0n
Copy link
Contributor Author

Got it, I reversed those changes.

BTW I can be added to the OCaml technical committee if you wish, I have a basic understanding of how the pieces move for the OCaml generator now.

@cgensoul

@wing328
Copy link
Member

wing328 commented Aug 25, 2025

BTW I can be added to the OCaml technical committee if you wish, I have a basic understanding of how the pieces move for the OCaml generator now.

yes, please

thanks for joining us to help move this project forward

@sir4ur0n
Copy link
Contributor Author

Done in e5a205a in this MR

@wing328 wing328 merged commit 3d93cc0 into OpenAPITools:master Aug 25, 2025
18 checks passed
Goopher pushed a commit to Goopher/openapi-generator that referenced this pull request Sep 9, 2025
…penAPITools#21809)

* [OCaml] Generate .ocamlformat file

Fixes OpenAPITools#21806

* [OCaml] Run `dune fmt` on all OCaml folders

* Don't format in Git

* Add myself for OCaml
@wing328 wing328 added this to the 7.16.0 milestone Sep 28, 2025
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.

[REQ][OCaml] Format generated files

2 participants