From 1db1b06c9e2da15fb978fd39767fe5d76467c1f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= Date: Mon, 1 Aug 2022 16:36:10 +0200 Subject: [PATCH] Website: correct the OpenAPI commit guidelines The OpenAPI-generated code no longer contains the git hash, so the docs had to change for that. --- .../content/development/openapi-commit-guidelines/_index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/web/project-website/content/development/openapi-commit-guidelines/_index.md b/web/project-website/content/development/openapi-commit-guidelines/_index.md index fe531478..64523a85 100644 --- a/web/project-website/content/development/openapi-commit-guidelines/_index.md +++ b/web/project-website/content/development/openapi-commit-guidelines/_index.md @@ -19,7 +19,6 @@ steps: 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. +- The regenerated code has the right Flamenco version number. - Changes to manually-written and generated code are tracked in separate commits. This makes them easier to comprehend by humans.