From b73ba60d7a6b950992bab4caebaf8ef1f5b81096 Mon Sep 17 00:00:00 2001 From: Lari Hotari Date: Mon, 14 Oct 2024 20:47:51 +0300 Subject: [PATCH] Revisit release process --- contribute/release-note-guide.md | 15 ++++++++++++++- contribute/release-process.md | 16 ++++++++++++++-- 2 files changed, 28 insertions(+), 3 deletions(-) diff --git a/contribute/release-note-guide.md b/contribute/release-note-guide.md index abe34ad126da..9ec46af3920e 100644 --- a/contribute/release-note-guide.md +++ b/contribute/release-note-guide.md @@ -50,6 +50,13 @@ VERSION_WITHOUT_RC=3.0.6 ./scripts/register_new_version.py $VERSION_WITHOUT_RC $(gh release view "v$VERSION_WITHOUT_RC" -R apache/pulsar --json author,publishedAt | jq -r '[.author.login, .publishedAt] | join(" ")') ``` +Alternatively, for a tag instead of a release: + +```bash +# For a tag instead of a release +./scripts/register_new_version.py $VERSION_WITHOUT_RC $(cd $PULSAR_PATH && git show -s --format="%ae %aI" "v$VERSION_RC" | tail -n 1 | sed 's/@.* / /') +``` + ## Generate release notes There isn't a definite way yet. @@ -73,7 +80,13 @@ git log --reverse --oneline v$PREVIOUS_VERSION..v$VERSION_WITHOUT_RC | colrm 1 Alternatively using "gh pr list" ```bash -gh pr list -L 1000 --search "is:pr is:merged label:release/2.10.6 label:cherry-picked/branch-2.10" --json title,number,url | jq -r '.[] | "\(.title) [\(.number)](\(.url))"' +gh pr list -L 1000 --search "is:pr is:merged label:release/2.10.6 label:cherry-picked/branch-2.10" --json title,number,url | jq -r '.[] | "- \(.title) ([#\(.number)](\(.url)))"' | sort | pbcopy +``` + +For feature releases, using the milestone: + +```bash +gh pr list -L 1000 --search "is:pr is:merged milestone:4.0.0" --json title,number,url | jq -r '.[] | "- \(.title) ([#\(.number)](\(.url)))"' | sort | pbcopy ``` ## Update the release note page diff --git a/contribute/release-process.md b/contribute/release-process.md index 00fec7c1c86c..e7486c8dc29e 100644 --- a/contribute/release-process.md +++ b/contribute/release-process.md @@ -810,6 +810,12 @@ Once the docs are generated, you can add them and submit them in a PR. The expec * `static/api/client` * `static/api/pulsar-functions` +```shell +cd ../.. +git add static/api/* +git commit -m "update java-apidoc for $VERSION_WITHOUT_RC" +``` + Read more on the manual of [pytools](https://github.com/apache/pulsar-site/tree/main/tools/pytools/README.md). ### Reference @@ -829,6 +835,12 @@ poetry install poetry run bin/reference-doc-generator.py --master-path=$PULSAR_PATH --version=$VERSION_WITHOUT_RC ``` +```shell +cd ../.. +git add static/reference/* +git commit -m "update reference for $VERSION_WITHOUT_RC" +``` + Once the docs are generated, you can add them and submit them in a PR. The expected doc output is `static/reference/2.X.x` Read more on the manual of [pytools](https://github.com/apache/pulsar-site/tree/main/tools/pytools/README.md). @@ -839,7 +851,7 @@ Read more on the manual of [pytools](https://github.com/apache/pulsar-site/tree/ If you're working on a patch release for an older feature version of Pulsar, you can skip this step. -Otherwise, you should update the version in this file: +Otherwise, you should update the version in this file: `static/.htaccess` ## Update `/docs` version list dropdown @@ -855,7 +867,7 @@ LTS versions should be labeled this way: ` LTS`. If you're working on a patch release for an older feature version of Pulsar, you can skip this step. -Otherwise, you should update the dropdown version list in this file: +Otherwise, you should update the dropdown version list in this file: `src/theme/DocsVersionDropdownNavbarItem.js` ## Announce the release