Skip to content

Commit

Permalink
docs: Drop hub command from the RELEASE.md (#585)
Browse files Browse the repository at this point in the history
The current RELEASE.md relies on the `hub` command. I ran into authorization
issues while trying to use `hub` for the release that were not easy to
resolve. The problems I encountered are captured in a still open `hub`
issue: mislav/hub#2655. Given the extra steps
required to work around and resolve this issue, I think it would be
simpler to frame the release instructions in terms of local `git`
commands and Github UI.

This change updates the RELEASE.md to replace `hub` commands with local
`git` commands and Github UI instructions.
  • Loading branch information
r-hang authored Jun 13, 2023
1 parent b9b2699 commit 8fb12f0
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,6 @@
Release process
===============

Prerequisites
-------------

Make sure you have `hub` installed.

```
brew install hub
```

Releasing
---------

Expand Down Expand Up @@ -66,9 +57,11 @@ To release new versions of ThriftRW Go, follow these instructions.
git add version/version.go CHANGELOG.md
git commit -m "Preparing release v$VERSION"

8. Make a pull request with these changes against `master`.
8. Make a pull request with these changes against `master`. Push the recently
created release branch to origin and create a new pull request into `master`
in the Github UI.

hub pull-request -b master --push
git push origin HEAD:$(whoami)/release

9. Land the pull request after approval as a **merge commit**. To do this,
select **Create a merge commit** from the pull-down next to the merge
Expand All @@ -93,7 +86,13 @@ To release new versions of ThriftRW Go, follow these instructions.

11. Tag a release.

hub release create -o -m v$VERSION -t master v$VERSION
git tag -a v$VERSION -m v$VERSION
git push origin v$VERSION

Go to the "Release" section in the Github UI, and click "Draft a new release".
Select the tag you just pushed to origin. The release title should be the
tag name (e.g. v$VERSION) and the contents of the CHANGELOG.md for the
for the release version should be copied into the release description.

12. Copy the changelog entries for this release into the release description
in the newly opened browser window.
Expand Down Expand Up @@ -134,10 +133,12 @@ To release new versions of ThriftRW Go, follow these instructions.

make generate

18. Open a PR with your changes against `dev` to back to development.
18. Open a PR with your changes against `dev` to back to development. Push
the recently created `back-to-dev` branch to origin and create a pull
request into `dev` from the Github UI.

git commit -am "Back to development"
hub pull-request -b dev --push
git push origin back-to-dev

19. Merge this pull request once approved as a merge commit.

Expand Down

0 comments on commit 8fb12f0

Please sign in to comment.