Skip to content

Commit 5e480ed

Browse files
committed
Add more info about releasing
1 parent 249e535 commit 5e480ed

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.dev.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,17 @@ Add this to ~/.gnupg/gpg-agent.conf:
9999
- Ensure you have a clean checkout of `master` and that the subdirectory
100100
`.gh-pages` either does not exist or is a clean checkout.
101101
- We'll be generating commits.
102+
- Review open issues and PRs to see if any can easily be fixed, closed, or
103+
merged.
104+
- Review `CHANGELOG.md` for completeness and correctness.
102105
- Set a version and a date in `CHANGELOG.md` and commit that.
103106
- It gets used in the release process.
107+
- Bump version in `README.md` if appropriate.
108+
- You don't need to update the version. `./dev-bin/release.sh` does this.
104109
- Run `./dev-bin/release.sh`
110+
- This will package the release, update the gh-pages branch, bump the
111+
version to the next development release, upload the release to GitHub
112+
and tag it, and upload to Sonatype.
105113
- This will prompt you several times. Generally you need to say `y` or `n`.
106114
- You'll be prompted for your ssh key password, GPG key password, and
107115
GitHub.com username and password several times depending on your
@@ -129,6 +137,9 @@ Add this to ~/.gnupg/gpg-agent.conf:
129137
you wait. Eventually you should see the "Activity" line in the info
130138
about your repository say something like it is complete.
131139
- Click Release near the top.
140+
- This also takes a moment (you will see "operation in progress" again).
141+
Refresh as usual. When it's done, you won't see the "commmaxmind-xxxx"
142+
entry in the staging repositories any more.
132143
- You're done!
133144
- If you want to check things over, look at the commits on GitHub.com,
134145
including to the `gh-pages` branch and release tags, and do an artifact

0 commit comments

Comments
 (0)