From 6f5f4b090a836a70d1e0cd2f281d383ac1a89a7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dan=20Gr=C3=B8ndahl?= Date: Tue, 7 Apr 2026 08:48:39 +0200 Subject: [PATCH] docs: split changelog workflow and use tag-based releases Changelog workflow now only documents tagged releases instead of all merged PRs, preventing unreleased features from appearing. Terraform reference updates are split into a separate workflow. --- .mintlify/workflows/update-changelog.md | 6 ++-- .../workflows/update-terraform-reference.md | 30 +++++++++++++++++++ 2 files changed, 33 insertions(+), 3 deletions(-) create mode 100644 .mintlify/workflows/update-terraform-reference.md diff --git a/.mintlify/workflows/update-changelog.md b/.mintlify/workflows/update-changelog.md index 9d83a92d..150dd357 100644 --- a/.mintlify/workflows/update-changelog.md +++ b/.mintlify/workflows/update-changelog.md @@ -14,11 +14,11 @@ notify: # Agent Instructions -Review all PRs merged to the kosli-dev/cli, kosli-dev/terraform-provider-kosli, and kosli-dev/server repositories since the last changelog update component was added. +Check each repository (kosli-dev/cli, kosli-dev/terraform-provider-kosli, kosli-dev/server) for **new tags/releases** published since the last changelog entry for that product in changelog/index.mdx. Only document changes that are part of a tagged release — do not include unreleased work on `main`. -Write a changelog post under changelog/index.mdx for this week based on what shipped. If no changelogs exists yet for a given repository, only consider changes for the past week. +For each new release tag found, write a changelog entry in changelog/index.mdx. If no new tags exist for a repository since its last changelog entry, skip it. If there are no new tags across any repository, do not open a PR. -Make sure to update resources and data sources in `terraform-reference/` to match `kosli-dev/terraform-provider-kosli`. Make sure when copy documentation across to use Mintlify formatting. +This workflow only updates changelog/index.mdx. Do not modify any other files. Label should be the date the workflow runs, like "March 16, 2026". Description should be the version number of the release, like "v0.3.0". Tags should be the product(s) affected by the release: diff --git a/.mintlify/workflows/update-terraform-reference.md b/.mintlify/workflows/update-terraform-reference.md new file mode 100644 index 00000000..e7ca7443 --- /dev/null +++ b/.mintlify/workflows/update-terraform-reference.md @@ -0,0 +1,30 @@ +--- +name: "Update Terraform reference" +on: + cron: "0 9 * * 1" +context: + - repo: "kosli-dev/terraform-provider-kosli" +notify: + slack: + channels: + - docs +--- + +# Agent Instructions + +Check kosli-dev/terraform-provider-kosli for **new tags/releases** published since the last Terraform Provider changelog entry in changelog/index.mdx. Only document changes that are part of a tagged release — do not include unreleased work on `main`. + +If no new tags exist since the last Terraform Provider changelog entry, do not open a PR. + +Update the Terraform reference docs in `terraform-reference/` to match the latest tagged release of kosli-dev/terraform-provider-kosli: + +1. **New resources** — if a new resource was added, create a page under `terraform-reference/resources/` and add it to the navigation in `docs.json`. +2. **New data sources** — if a new data source was added, create a page under `terraform-reference/data-sources/` and add it to the navigation in `docs.json`. +3. **Updated resources/data sources** — if attributes were added, removed, or changed on an existing resource or data source, update the corresponding page. + +When creating or updating pages: +- Follow Mintlify formatting conventions. Review existing pages in `terraform-reference/` for style reference. +- Use root-relative links (e.g., `/terraform-reference/resources/environment`). +- 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.