Skip to content

Commit

Permalink
Clarify release guide for publishing release notes to GitHub (apache#…
Browse files Browse the repository at this point in the history
…12015)

* Clarify release guide for publishing release notes to GitHub

* upstream -> origin

* Address PR comments
  • Loading branch information
TheNeuralBit committed Jun 15, 2020
1 parent 34dff56 commit dc8df09
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions website/www/site/content/en/contribute/release-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -1126,21 +1126,31 @@ Verify that:
* Images with *latest* tag are pointing to current release by confirming
1. Digest of the image with *latest* tag is the same as the one with {RELEASE} tag.

### Merge Website pull requests

Merge all of the website pull requests
- [listing the release](/get-started/downloads/)
- publishing the [Python API reference manual](https://beam.apache.org/releases/pydoc/) and the [Java API reference manual](https://beam.apache.org/releases/javadoc/), and
- adding the release blog post.

### Git tag

Create and push a new signed tag for the released version by copying the tag for the final release candidate, as follows:

VERSION_TAG="v${RELEASE}"
git tag -s "$VERSION_TAG" "$RC_TAG"
git push upstream "$VERSION_TAG"
```
VERSION_TAG="v${RELEASE}"
git tag -s "$VERSION_TAG" "$RC_TAG"
git push https://github.com/apache/beam "$VERSION_TAG"
```

After the tag is uploaded, publish the release notes to Github:
After the tag is uploaded, publish the release notes to Github, as follows:

./beam/release/src/main/scripts/publish_github_release_notes.sh
```
cd beam/release/src/main/scripts && ./publish_github_release_notes.sh
```

### Merge website pull request
Note this script reads the release notes from the blog post, so you should make sure to run this from master _after_ merging the blog post PR.

Merge the website pull request to [list the release](/get-started/downloads/), publish the [Python API reference manual](https://beam.apache.org/releases/pydoc/), the [Java API reference manual](https://beam.apache.org/releases/javadoc/) and Blogpost created earlier.

### Mark the version as released in JIRA

Expand Down

0 comments on commit dc8df09

Please sign in to comment.