Conversation
It is now clear which branch should be used (release-next or master) Signed-off-by: Maël Valais <mael@vls.dev>
cert-manager-prow
bot
added
the
dco-signoff: no
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
cert-manager-prow
bot
added
the
size/L
✅ Deploy Preview for cert-manager ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Updates the contributor release-process documentation to reflect a revised set of website PRs (docs freeze, release notes, version bumps) and adjusts the later “merge website PRs” portion of the checklist.
Changes:
- Replaces/rewrites the website pre-release steps (adds a “Docs Freeze” PR step and refactors “Release Notes” + “Version Bumps” guidance).
- Updates later step numbering and the website PR merge steps.
- Adds/updates examples for file paths and
manifest.jsonentries.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```yaml | ||
| { | ||
| "routes": [ | ||
| # ... | ||
| { |
There was a problem hiding this comment.
This fenced code block is labeled as yaml, but the example is JSON (and includes a # ... comment which is not valid JSON). Please switch the fence to json/jsonc (or remove the comment) so readers can copy/paste and tooling highlighting is accurate.
| }, | ||
| { | ||
| "title": "1.20", | ||
| "path": "/docs/releases/release-notes/release-notes-1.20.md" |
There was a problem hiding this comment.
In the manifest example, the release notes route path is shown as /docs/releases/release-notes/release-notes-1.20.md, but elsewhere the docs link to release notes under /docs/release-notes/ (e.g., content/docs/releases/README.md points to https://cert-manager.io/docs/release-notes/). Please correct the example path to match the actual release notes URL structure.
| "path": "/docs/releases/release-notes/release-notes-1.20.md" | |
| "path": "/docs/release-notes/release-notes-1.20.md" |
| Imagining that you are about to release v1.20.0, edit `scripts/gendocs/generate-new-import-path-docs` to change the line that starts with `genversionwithcli` to this: | ||
|
|
||
| This copies the `docs/` folder to a versioned folder (e.g. `v1.15-docs`) and removes any | ||
| folders which should not be present in versioned docs. | ||
| ``` | ||
| CM_BRANCH="release-1.20" | ||
| DOCS_FOLDER="docs" | ||
| ``` |
There was a problem hiding this comment.
These instructions suggest changing scripts/gendocs/generate-new-import-path-docs to set CM_BRANCH and DOCS_FOLDER, but that script currently doesn't define or use those variables and instead calls genversionwithcli "release-1.xx" "$LATEST_VERSION". As written, the doc is not actionable; please update the instructions to match the script’s real knobs (e.g., updating the genversionwithcli line and/or LATEST_VERSION).
| 11. Send a Slack message to `#cert-manager-dev` to announce that you are starting the release: | ||
|
|
||
| :::info | ||
|
|
||
| Releasing `v1.20.0` 🧵 | ||
|
|
||
| ::: | ||
|
|
||
| 11. Go through the `cmrel` publish process: | ||
| 12. Go through the `cmrel` publish process: |
There was a problem hiding this comment.
Step numbering skips from 9 to 11 here (there is no step 10), which makes referencing the process difficult. Please renumber this and the subsequent steps so the sequence is continuous (e.g., this Slack announcement step should be 10 if nothing else was inserted).
| 15. **(final + patch releases)** Merge the 4 Website PRs: | ||
| 16. (**final releases**) Merge the "Docs Freeze" PR. | ||
|
|
||
| 17. (**final + patch releases**) |
There was a problem hiding this comment.
This step header is incomplete: 17. (**final + patch releases**) has no action/description, and the merge instructions start immediately below. Please add a short title (e.g., "Merge website PRs"), or fold the sub-steps into a properly described step so readers understand what step 17 is for.
| 17. (**final + patch releases**) | |
| 17. (**final + patch releases**) Merge website PRs. |
| 5. (**final release**) Prepare the "Docs Freeze" PR | ||
|
|
||
| This can be prepared ahead of time. | ||
| **⚠️ This step can be done ahead of time.** | ||
|
|
||
| Imagining that you are about to release v1.20.0, run the following from the master branch: | ||
| ``` | ||
| ./scripts/freeze-docs 1.19 | ||
| ``` | ||
|
|
||
| 4. **(final + patch releases)** Prepare the Website "Release Notes" PR. | ||
| Then, create a PR "Freeze 1.19" on `master`. | ||
|
|
||
| 4. (**final + patch releases**) Prepare the "Release Notes" PR. |
There was a problem hiding this comment.
The top-level ordered list numbering is out of sequence here (jumps from step 2 to 5, then back to 4, then repeats 5). This makes the release process hard to follow and will render confusingly in Markdown. Please renumber these steps sequentially (e.g., 3=Docs Freeze, 4=Release Notes, 5=Version Bumps) and ensure subsequent steps stay consistent.
|
|
||
| 1. (**final release**) Create a new file `content/docs/release-notes/release-notes-1.xx.md`. | ||
| - If you are doing a **final release**, then this PR's base must be the `release-next` branch. | ||
| - If you are doing a **patch release**, then this PR's base must be `master`. |
There was a problem hiding this comment.
The bullet list indentation is inconsistent: the "patch release" bullet is less indented than the "final release" bullet, which breaks the list formatting in Markdown. Align the indentation so both bullets are part of the same list under this step.
| - If you are doing a **patch release**, then this PR's base must be `master`. | |
| - If you are doing a **patch release**, then this PR's base must be `master`. |
| The PR will contain the following: | ||
|
|
||
| 2. (**final release**) Add an entry to `content/docs/manifest.json` for the new release note file: | ||
| 1. Run the `release-notes` command (see instructions further down below in this page). | ||
|
|
||
| ```diff | ||
| { | ||
| "title": "Release Notes", | ||
| "routes": [ | ||
| + { | ||
| + "title": "v1.12", | ||
| + "path": "/docs/release-notes/release-notes-1.12.md" | ||
| + }, | ||
| ``` | ||
| 1. (**final release**) Move the generated `website-release-notes.md` to `content/docs/release-notes/release-notes-1.20.md`. Make sure to edit it to match the format of our past release notes. | ||
|
|
||
| 3. Add or update the "Major themes" and "Community" sections, taking inspiration from | ||
| previous release note pages. For final releases this will take some time; for | ||
| patch releases this should be a minor task and usually will not need to be done. | ||
| 2. (**patch release**) Add the contents of the generated `website-release-notes.md` to a new section of the existing release, e.g., in `content/docs/release-notes/release-notes-1.20.md`. | ||
|
|
||
| 2. (**final release**) Create a new file: | ||
| ``` | ||
| content/docs/releases/upgrading/upgrading-1.19-1.20.md | ||
| ``` | ||
|
|
||
| 5. **(final + patch release)** Prepare the Website "Bump Versions" PR. | ||
| See for | ||
| example: [upgrading-1.0-1.1](https://cert-manager.io/docs/releases/upgrading/upgrading-1.0-1.1.md). | ||
|
|
||
| **⚠️ This step can be done ahead of time.** | ||
| 2. (**final release**) Add an entry to `content/docs/manifest.json` for the new release note file: |
There was a problem hiding this comment.
The ordered sub-list under "The PR will contain the following" uses repeated numbers (1, 1, 2, 2, 2), which is easy to misread and inconsistent with the sequential numbering used elsewhere in this document. Please renumber these sub-steps sequentially (or use all 1. consistently if you intend Markdown auto-numbering) so the rendered instructions are unambiguous.
|
Thanks for your pull request. Before we can look at it, you'll need to add a 'DCO signoff' to your commits. 📝 Please follow instructions in the contributing guide to update your commits with the DCO Full details of the Developer Certificate of Origin can be found at developercertificate.org. The list of commits missing DCO signoff:
DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
Preview: https://hackmd.io/@maelvls/HJdwHAAtWe