Skip to content
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

chore: update release template #6883

Merged
merged 6 commits into from
Jan 20, 2025
Merged

chore: update release template #6883

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6b6450e
chore: update release template
mlavacca Dec 20, 2024
1784b39
address comments
mlavacca Dec 23, 2024
429d1a9
Merge branch 'main' into update-release-template
mlavacca Jan 7, 2025
eeaedc2
Merge branch 'main' into update-release-template
mlavacca Jan 9, 2025
8486428
Merge branch 'main' into update-release-template
mlavacca Jan 20, 2025
87c9480
Merge branch 'main' into update-release-template
mlavacca Jan 20, 2025
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
6 changes: 4 additions & 2 deletions .github/ISSUE_TEMPLATE/release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,15 @@ body:
attributes:
label: "**For major/minor releases only** Update Release documents"
options:
- 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.
- label: Trigger [release_docs](https://github.com/Kong/kubernetes-ingress-controller/blob/main/.github/workflows/release_docs.yaml) workflow.
- label: Ensure a draft PR is created in [docs.konghq.com](https://github.com/Kong/docs.konghq.com/pulls) repository.
- 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.
- label: Update articles in the new version as needed.
- label: Update `reference/version-compatibility.md` to include the new versions (make sure you capture any new Kubernetes/Istio versions that have been tested)
- 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.
- label: Make sure that `app/_data/docs_nav_kic_NEWVERSION.yml` links to the latest generated `custom-resources-X.X.X.md`.
- label: Make sure that `app/_data/docs_nav_kic_NEWVERSION.yml` custom resources link to the latest generated `custom-resources-X.X.X.md`.
- label: Make sure that `app/_data/docs_nav_kic_NEWVERSION.yml` cli arguments link to the latest generated `cli-arguments-X.X.X.md`.
- 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.
- label: Add a section to `app/_data/kong_versions.yml` for your version and move the `latest` field to version that's being released.
- label: "Add entries in support policy documents: `app/_src/kubernetes-ingress-controller/support-policy.md` and `app/_includes/md/kic/support.md`."
- label: Mark the PR ready for review.
Expand Down
Loading