Skip to content

Commit bcf2d43

Browse files
add sync CRD reference step
Signed-off-by: Jintao Zhang <zhangjintao9020@gmail.com>
1 parent 2f0b653 commit bcf2d43

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

.github/ISSUE_TEMPLATE/---release.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,7 @@ If the troubleshooting section does not contain the answer to the problem you en
2929
- [ ] Check the [releases][releases] page. The release has to be marked manually as `latest` if this is the case.
3030
- [ ] Check the `release/N.M.x` release branch exists.
3131
- [ ] Update the official documentation at [https://github.com/Kong/developer.konghq.com/][docs_repo]
32-
- [ ] 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`.
33-
This will add the necessary skaffolding so that the reference is rendered correctly on docs.konghq.com.
34-
35-
Example:
36-
37-
```sh
38-
${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
39-
```
32+
- **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.
4033

4134
## Conformance tests report
4235

.github/workflows/__release-workflow.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,7 @@ jobs:
362362
env:
363363
DOCS_REPO: developer.konghq.com
364364
DOCS_REPO_PATH_CLI_ARGS_DOC: app/operator/reference/configuration-options.md
365+
DOCS_REPO_PATH_CRD_DOC: app/operator/reference/custom-resources.md
365366
needs:
366367
- semver
367368
- create-release-pr
@@ -385,6 +386,14 @@ jobs:
385386
run: |
386387
cp ./docs/cli-arguments-for-developer-konghq-com.md ${{ env.DOCS_REPO }}/${{ env.DOCS_REPO_PATH_CLI_ARGS_DOC }}
387388
389+
- name: update CRD reference docs
390+
run: |
391+
mkdir -p "$(dirname "${{ env.DOCS_REPO }}/${{ env.DOCS_REPO_PATH_CRD_DOC }}")"
392+
./scripts/apidocs-gen/post-process-for-konghq.sh \
393+
./docs/gateway-operator-api-reference.md \
394+
"${{ env.DOCS_REPO }}/${{ env.DOCS_REPO_PATH_CRD_DOC }}" \
395+
"${{ env.DOCS_REPO }}"
396+
388397
- name: Detect changes
389398
id: detect-changes
390399
run: |

0 commit comments

Comments
 (0)