chore: update release template #6883
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6883 +/- ##
========================================
+ Coverage 59.0% 76.4% +17.3%
========================================
Files 210 212 +2
Lines 25241 25246 +5
========================================
+ Hits 14917 19312 +4395
+ Misses 9030 4913 -4117
+ Partials 1294 1021 -273 ☔ View full report in Codecov by Sentry. |
| - 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`. |
There was a problem hiding this comment.
You'll need to copy the files as well.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
I've addressed it in 1784b39. PTAL
Signed-off-by: Mattia Lavacca <[email protected]>
Signed-off-by: Mattia Lavacca <[email protected]>
mlavacca
force-pushed
the
update-release-template
branch
from
583d8ee to
1784b39
Compare
What this PR does / why we need it:
Make the release instructions a bit clearer.
Which issue this PR fixes:
Special notes for your reviewer:
PR Readiness Checklist:
Complete these before marking the PR as
ready to review:CHANGELOG.mdrelease notes have been updated to reflect any significant (and particularly user-facing) changes introduced by this PR