Skip to content

Commit ac70d1f

Browse files
authored
chore: update release template (#6883)
* chore: update release template Signed-off-by: Mattia Lavacca <[email protected]> * address comments Signed-off-by: Mattia Lavacca <[email protected]> --------- Signed-off-by: Mattia Lavacca <[email protected]>
1 parent e572963 commit ac70d1f

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

.github/ISSUE_TEMPLATE/release.yaml

+4-2
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,15 @@ body:
5151
attributes:
5252
label: "**For major/minor releases only** Update Release documents"
5353
options:
54-
- label: Trigger [release_docs](https://github.com/Kong/kubernetes-ingress-controller/blob/main/.github/workflows/release_docs.yaml) workflow. Note that you will need to update the new version's navigation manifest (e.g. [for 2.7](https://github.com/Kong/docs.konghq.com/blob/main/app/_data/docs_nav_kic_2.7.x.yml) to use the new files (CRDs and CLI arguments references) after.
54+
- label: Trigger [release_docs](https://github.com/Kong/kubernetes-ingress-controller/blob/main/.github/workflows/release_docs.yaml) workflow.
5555
- label: Ensure a draft PR is created in [docs.konghq.com](https://github.com/Kong/docs.konghq.com/pulls) repository.
5656
- label: If you are adding a new CRD, add a new description file under `app/_includes/md/kic/crd-ref/`. This is a brief description injected into the CRD reference page.
5757
- label: Update articles in the new version as needed.
5858
- label: Update `reference/version-compatibility.md` to include the new versions (make sure you capture any new Kubernetes/Istio versions that have been tested)
5959
- label: Copy `app/_data/docs_nav_kic_OLDVERSION.yml` to `app/_data/docs_nav_kic_NEWVERSION.yml` and update the `release` field to `NEWVERSION`. Add entries for any new articles.
60-
- label: Make sure that `app/_data/docs_nav_kic_NEWVERSION.yml` links to the latest generated `custom-resources-X.X.X.md`.
60+
- label: Make sure that `app/_data/docs_nav_kic_NEWVERSION.yml` custom resources link to the latest generated `custom-resources-X.X.X.md`.
61+
- label: Make sure that `app/_data/docs_nav_kic_NEWVERSION.yml` cli arguments link to the latest generated `cli-arguments-X.X.X.md`.
62+
- label: Create the nav page for the next release in `app/_data/docs_nav_kic_NEXTVERSION.yml`. However, don't update yet its links to `custom-resources-X.X.X.md` and `cli-arguments-X.X.X.md`, as it will be part of the next release process.
6163
- label: Add a section to `app/_data/kong_versions.yml` for your version and move the `latest` field to version that's being released.
6264
- label: "Add entries in support policy documents: `app/_src/kubernetes-ingress-controller/support-policy.md` and `app/_includes/md/kic/support.md`."
6365
- label: Mark the PR ready for review.

0 commit comments

Comments
 (0)