05e82ea5e4
The flamenco.io website moves to flamenco.blender.org! This commit updates the Makefile as follows: - Rename 'site' to 'project-website', so the new command to deploy is 'make project-website' - Move the website directory from 'flamenco-io-site' to 'project-website' - Update the rsync command do reflect the new deployment destination
978 B
978 B
| title | weight |
|---|---|
| OpenAPI Commit Guidelines | 30 |
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.
Each of these steps should be committed independently, by following these steps:
- Commit the changes to
pkg/api/flamenco-openapi.yaml, prefixing the commit message withOAPI:. - Regenerate code with
make generate, then commit with messageOAPI: Regenerate code. - Commit any other code changes to complete the change.
The downside to this approach is that the second commit will likely break the project, which is unfortunate. However, this approach does have some advantages:
- The regenerated code has the commit hash of the actual change to the OpenAPI definition.
- Changes to manually-written and generated code are tracked in separate commits. This makes them easier to comprehend by humans.