Skip to content

CI: add sync CRD reference step #2775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tao12345666333 merged 3 commits into from
Jan 22, 2026
Merged

CI: add sync CRD reference step #2775

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98a34e9
add sync CRD reference step
tao12345666333 Nov 28, 2025
35468b0
clarify when to set latest: true
tao12345666333 Jan 20, 2026
45dc110
Merge branch 'main' into sync-crd-reference-step
pmalek Jan 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions .github/ISSUE_TEMPLATE/---release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,7 @@ If the troubleshooting section does not contain the answer to the problem you en
- [ ] Check the [releases][releases] page. The release has to be marked manually as `latest` if this is the case.
- [ ] Check the `release/N.M.x` release branch exists.
- [ ] Update the official documentation at [https://github.com/Kong/developer.konghq.com/][docs_repo]
- [ ] Run post processing script for `${KUBERNETES_CONFIGURATION_REPO}/docs/gateway-operator-api-reference.md`, providing a tagged version of CRD reference from docs repo as an argument, e.g. `app/_src/gateway-operator/reference/custom-resources/1.2.x.md`.
This will add the necessary skaffolding so that the reference is rendered correctly on docs.konghq.com.

Example:

```sh
${KUBERNETES_CONFIGURATION_REPO}/scripts/apidocs-gen/post-process-for-konghq.sh ${KUBERNETES_CONFIGURATION_REPO}/docs/gateway-operator-api-reference.md ${KONGHQ_DOCS_REPO}/app/_src/gateway-operator/reference/custom-resources/1.2.x.md
```
- **CLI configuration options** and **CRD reference**: Automatically synced by the release workflow. A PR will be created in the docs repo. Review and merge it when ready.

## Conformance tests report

Expand Down
16 changes: 15 additions & 1 deletion .github/workflows/__release-workflow.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,12 @@ on:
default: 'main'
required: false
latest:
description: Whether to mark this release latest
description: |
Whether to mark this release latest.
Only set to true if this release is the current maximum version.
If a newer major or minor version has been released (e.g., 2.2 is released),
do NOT set this to true when releasing an older branch (e.g., 2.1.1),
otherwise the docs will be overwritten.
type: boolean
default: false
release-type:
Expand Down Expand Up @@ -362,6 +367,7 @@ jobs:
env:
DOCS_REPO: developer.konghq.com
DOCS_REPO_PATH_CLI_ARGS_DOC: app/operator/reference/configuration-options.md
DOCS_REPO_PATH_CRD_DOC: app/operator/reference/custom-resources.md
needs:
- semver
- create-release-pr
Expand All @@ -385,6 +391,14 @@ jobs:
run: |
cp ./docs/cli-arguments-for-developer-konghq-com.md ${{ env.DOCS_REPO }}/${{ env.DOCS_REPO_PATH_CLI_ARGS_DOC }}

- name: update CRD reference docs
run: |
mkdir -p "$(dirname "${{ env.DOCS_REPO }}/${{ env.DOCS_REPO_PATH_CRD_DOC }}")"
./scripts/apidocs-gen/post-process-for-konghq.sh \
./docs/gateway-operator-api-reference.md \
"${{ env.DOCS_REPO }}/${{ env.DOCS_REPO_PATH_CRD_DOC }}" \
"${{ env.DOCS_REPO }}"

- name: Detect changes
id: detect-changes
run: |
Expand Down
Loading