This is an automated email from the ASF dual-hosted git repository.
damccorm pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/beam.git
The following commit(s) were added to refs/heads/master by this push:
new 5ffb2d539f2 Update release docs with problems encountered during
release (#25596)
5ffb2d539f2 is described below
commit 5ffb2d539f28863786689cbbd05d6c1a21327228
Author: Danny McCormick <[email protected]>
AuthorDate: Wed Mar 15 10:33:21 2023 -0400
Update release docs with problems encountered during release (#25596)
* WIP - Update release docs as I go
* typo
* Gpg key
* Remove htaccess action (we don't need to do this)
* Add PR against release branch to email
* Add xlang info
* Remove kubernetes admin add in (I don't think its right)
* fix-version to milestone
---
release/src/main/scripts/start_snapshot_build.sh | 2 +-
website/www/site/content/en/contribute/release-guide.md | 16 ++++++++++++++--
2 files changed, 15 insertions(+), 3 deletions(-)
diff --git a/release/src/main/scripts/start_snapshot_build.sh
b/release/src/main/scripts/start_snapshot_build.sh
index d9b35f953ed..8c6d6ea8a3b 100755
--- a/release/src/main/scripts/start_snapshot_build.sh
+++ b/release/src/main/scripts/start_snapshot_build.sh
@@ -86,4 +86,4 @@ cd ~
rm -rf ${LOCAL_BEAM_DIR}
echo "Things remained you need to do manually after build successful:"
echo "1. Close this generated PR in github website."
-echo "2. Delete your remote branch ${BRANCH_NAME} form your beam repo in
github website."
+echo "2. Delete your remote branch ${BRANCH_NAME} from your beam repo in
github website."
diff --git a/website/www/site/content/en/contribute/release-guide.md
b/website/www/site/content/en/contribute/release-guide.md
index 2f67840004b..283acb4aef8 100644
--- a/website/www/site/content/en/contribute/release-guide.md
+++ b/website/www/site/content/en/contribute/release-guide.md
@@ -173,6 +173,10 @@ please submit your GPG public key into [MIT PGP Public Key
Server](http://pgp.mi
If MIT doesn't work for you (it probably won't, it's slow, returns 502 a lot,
Nexus might error out not being able to find the keys), use a keyserver at
`ubuntu.com` instead: https://keyserver.ubuntu.com/.
+You will need to use an ascii-armored version of your key.
+This can be obtained by running `gpg --export --armor` and copying the whole
block
+(including `-----<START/END> PGP PUBLIC KEY BLOCK-----`).
+
#### Website development setup
Updating the Beam website requires submitting PRs to both the main
`apache/beam` repo and the `apache/beam-site` repo.
@@ -277,6 +281,9 @@ After cutting the branch, you should manually update
`CHANGES.md` on `master` by
* **Script:**
[cut_release_branch.sh](https://github.com/apache/beam/blob/master/release/src/main/scripts/cut_release_branch.sh)
* **Usage**
+
+`RELEASE_VERSION` and `NEXT_VERSION` should be formatted like
`{major}.{minor}.{patch}` (e.g. `2.46.0`)
+
```
# Cut a release branch
./beam/release/src/main/scripts/cut_release_branch.sh \
@@ -303,6 +310,7 @@ There are 2 ways to trigger a nightly build, either using
automation script(reco
./beam/release/src/main/scripts/start_snapshot_build.sh
* **The script will:**
+ 1. Ask for the url of your personal clone of Beam (e.g.
`https://github.com/<user>/beam`).
1. Install [hub](https://github.com/github/hub) with your agreement.
1. Touch an empty txt file and commit changes into ```${your remote beam
repo}/snapshot_build```
1. Use hub to create a PR against apache:master, which triggers a Jenkins
job to build snapshot.
@@ -647,7 +655,6 @@ This pull request is against the `apache/beam` repo, on the
`master` branch ([ex
* Download links will not work until the release is finalized.
* Update links to prior releases to point to https://archive.apache.org (see
example PR).
-* Update `website/www/site/static/.htaccess` to redirect to the new version.
* Create the Blog post:
#### Blog post
@@ -790,6 +797,7 @@ Here’s an email template; please adjust as you see fit.
* Go artifacts and documentation are available at pkg.go.dev [9]
* Validation sheet with a tab for 1.2.3 release to help with validation
[10].
* Docker images published to Docker Hub [11].
+ * PR to run tests against release branch [12].
The vote will be open for at least 72 hours. It is adopted by majority
approval, with at least 3 PMC affirmative votes.
@@ -809,6 +817,7 @@ Here’s an email template; please adjust as you see fit.
[9]
https://pkg.go.dev/github.com/apache/beam/sdks/[email protected]/go/pkg/beam
[10]
https://docs.google.com/spreadsheets/d/1qk-N5vjXvbcEk68GjbkSZTR8AGqyNUM-oLFo_ZXBpJw/edit#gid=...
[11] https://hub.docker.com/search?q=apache%2Fbeam&type=image
+ [12] https://github.com/apache/beam/pull/...
If there are any issues found in the release candidate, reply on the vote
thread to cancel the vote.
There’s no need to wait 72 hours.
@@ -846,6 +855,9 @@ versions to run all of the tests. See Python installation
tips in [Developer Wik
* Start a new terminal to run python LeaderBoard with Dataflow Runner.
* Start a new terminal to run python GameStats with Direct Runner.
* Start a new terminal to run python GameStats with Dataflow Runner.
+ 1. Xlang validation, includes
+ * Start a new terminal to run python xlang Java kafka validation with
Dataflow Runner.
+ * Start a new terminal to run python xlang Java sql validation with
Dataflow Runner.
* **Tasks you need to do manually**
1. Check whether validations succeed by following console output
instructions.
@@ -1108,7 +1120,7 @@ Here’s an email template; please adjust as you see fit.
### Checklist to proceed to the next step
1. Issues identified during vote have been resolved, with fixes committed to
the release branch.
-2. All issues tagged with `Fix-Version` for the current release should be
closed.
+2. All issues in the current release's milestone should be closed.
3. Community votes to release the proposed candidate, with at least three
approving PMC votes.
