From 4d2b05247584da1d1ae36c545cc6bc9b4286e086 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dan=20Gr=C3=B8ndahl?= Date: Mon, 20 Apr 2026 11:55:55 +0200 Subject: [PATCH 1/2] fix: require conventional commits in Mintlify workflow instructions --- .mintlify/workflows/update-api-reference.md | 1 + .mintlify/workflows/update-changelog.md | 2 ++ .mintlify/workflows/update-terraform-reference.md | 2 ++ 3 files changed, 5 insertions(+) diff --git a/.mintlify/workflows/update-api-reference.md b/.mintlify/workflows/update-api-reference.md index 1bacd39..c4d097f 100644 --- a/.mintlify/workflows/update-api-reference.md +++ b/.mintlify/workflows/update-api-reference.md @@ -32,3 +32,4 @@ If new endpoint tags (groups) are introduced, add corresponding entries to the A - If no API changes were introduced, do nothing. - Do not include private repository file paths, directory structures, code snippets, or any other internal implementation details in PR titles, descriptions, or commit messages. The PR body should only describe the user-facing change in terms of the API behavior. - Do not modify any files other than `api-reference/openapi.json` and `config/navigation.json`. +- PR titles and commit messages **must** follow [Conventional Commits](https://www.conventionalcommits.org/) format: `type: short description` (lowercase, no period). Use `docs:` as the type. Example: `docs: update API reference for v2.5.0`. diff --git a/.mintlify/workflows/update-changelog.md b/.mintlify/workflows/update-changelog.md index 150dd35..a6747ee 100644 --- a/.mintlify/workflows/update-changelog.md +++ b/.mintlify/workflows/update-changelog.md @@ -40,3 +40,5 @@ For each change, describe what changed and what it means for users. Organize ent If unsure about the structure, review recent changelog updates and follow that style and format. Be polite and terse. The changelog must be skimmable and quick to read. Include relevant links to docs pages. + +PR titles and commit messages **must** follow [Conventional Commits](https://www.conventionalcommits.org/) format: `type: short description` (lowercase, no period). Use `docs:` as the type. Example: `docs: add changelog entry for CLI v2.5.0`. diff --git a/.mintlify/workflows/update-terraform-reference.md b/.mintlify/workflows/update-terraform-reference.md index e7ca744..34b42e2 100644 --- a/.mintlify/workflows/update-terraform-reference.md +++ b/.mintlify/workflows/update-terraform-reference.md @@ -28,3 +28,5 @@ When creating or updating pages: - Include example usage, schema (required/optional/read-only), and import instructions where applicable. Do not modify changelog/index.mdx — that is handled by the "Update changelog" workflow. + +PR titles and commit messages **must** follow [Conventional Commits](https://www.conventionalcommits.org/) format: `type: short description` (lowercase, no period). Use `docs:` as the type. Example: `docs: update Terraform reference for v1.3.0`. From 77050c546669f6a01644a0b696c1eeea1257f369 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dan=20Gr=C3=B8ndahl?= Date: Mon, 20 Apr 2026 11:58:35 +0200 Subject: [PATCH 2/2] fix: reference CLAUDE.md instead of duplicating convention details --- .mintlify/workflows/update-api-reference.md | 2 +- .mintlify/workflows/update-changelog.md | 2 +- .mintlify/workflows/update-terraform-reference.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.mintlify/workflows/update-api-reference.md b/.mintlify/workflows/update-api-reference.md index c4d097f..3effd78 100644 --- a/.mintlify/workflows/update-api-reference.md +++ b/.mintlify/workflows/update-api-reference.md @@ -32,4 +32,4 @@ If new endpoint tags (groups) are introduced, add corresponding entries to the A - If no API changes were introduced, do nothing. - Do not include private repository file paths, directory structures, code snippets, or any other internal implementation details in PR titles, descriptions, or commit messages. The PR body should only describe the user-facing change in terms of the API behavior. - Do not modify any files other than `api-reference/openapi.json` and `config/navigation.json`. -- PR titles and commit messages **must** follow [Conventional Commits](https://www.conventionalcommits.org/) format: `type: short description` (lowercase, no period). Use `docs:` as the type. Example: `docs: update API reference for v2.5.0`. +- PR titles and commit messages must follow the conventional commits format described in CLAUDE.md. Use `docs:` as the type. diff --git a/.mintlify/workflows/update-changelog.md b/.mintlify/workflows/update-changelog.md index a6747ee..961b7fd 100644 --- a/.mintlify/workflows/update-changelog.md +++ b/.mintlify/workflows/update-changelog.md @@ -41,4 +41,4 @@ If unsure about the structure, review recent changelog updates and follow that s Be polite and terse. The changelog must be skimmable and quick to read. Include relevant links to docs pages. -PR titles and commit messages **must** follow [Conventional Commits](https://www.conventionalcommits.org/) format: `type: short description` (lowercase, no period). Use `docs:` as the type. Example: `docs: add changelog entry for CLI v2.5.0`. +PR titles and commit messages must follow the conventional commits format described in CLAUDE.md. Use `docs:` as the type. diff --git a/.mintlify/workflows/update-terraform-reference.md b/.mintlify/workflows/update-terraform-reference.md index 34b42e2..c14a815 100644 --- a/.mintlify/workflows/update-terraform-reference.md +++ b/.mintlify/workflows/update-terraform-reference.md @@ -29,4 +29,4 @@ When creating or updating pages: Do not modify changelog/index.mdx — that is handled by the "Update changelog" workflow. -PR titles and commit messages **must** follow [Conventional Commits](https://www.conventionalcommits.org/) format: `type: short description` (lowercase, no period). Use `docs:` as the type. Example: `docs: update Terraform reference for v1.3.0`. +PR titles and commit messages must follow the conventional commits format described in CLAUDE.md. Use `docs:` as the type.