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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: update release template #6883

Changes from all commits
Commits
Show all changes
2 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
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`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll need to copy the files as well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In Kong/docs.konghq.com#8305 we needed to manually copy the files because we were adding the nav for 3.5 upfront (as unreleased). I don't think this is something good to do, as the cli args and the custom-resources files were automatically generated by the bot in Kong/docs.konghq.com#8298.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes but you need some to have an unreleased version. Referencing the old ones risk forgetting them so I'm not sure what's best here. TBH I think whatever we end up doing in: Kong/gateway-operator#35 would make this a lot simpler

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've addressed it in 1784b39. PTAL

- 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