blender/flamenco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Website: update OpenAPI commit guidelines

Browse Source 
Since the introduction of a `.gitattributes` file, tooling (like Gitea)
is aware of which files are generated. This means that all
OpenAPI-related changes (`pkg/api/flamenco-openapi.yaml`, re-generated
code, and changes to the implementation) can be commited together.

The downside is that tooling that is not aware of `.gitattributes` will
still show a big mix of hand-crafted and generated changes. The upside
is that each commit brings Flamenco from a valid, runnable state to
another valid, runnable state. This helps greatly when investigating
history (like bisecting) to find the source of a bug.
This commit is contained in:
Sybren A. Stüvel 2025-08-07 10:45:16 +02:00
parent 58e2745838
commit 01a97862db
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
web/project-website/content/development/openapi-commit-guidelines/_index.md
View File

@ -3,6 +3,19 @@ title: OpenAPI Commit Guidelines
weight: 30
---
{{< hint type=Warning >}}
**The guideline below has been obsolete since August 2025.** It will be kept
here for a while for historical reference.
Since the introduction of a `.gitattributes` file, tooling (like
[projects.blender.org][gitea]) is aware of which files are generated. This means
that **all changes** (`pkg/api/flamenco-openapi.yaml`, re-generated code, and
changes to the implementation) can be **commited together**.
[gitea]: https://projects.blender.org/studio/flamenco/
{{< /hint >}}
Typically a change to the OpenAPI definition consists of three steps, namely
making the change to the OpenAPI file, regenerating code, and then alter
whatever manually-written code needs altering.