Skip to content

Commit c0db501

Browse files
docs: update release instructions (#1440)
* docs: update release instructions * Update maintainers_guide.md * Update maintainers_guide.md * Update .github/maintainers_guide.md Co-authored-by: Michael Brooks <[email protected]> --------- Co-authored-by: Michael Brooks <[email protected]>
1 parent f8d2bce commit c0db501

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

.github/maintainers_guide.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,13 @@ Refer to the [README](https://github.com/slackapi/java-slack-sdk/blob/main/docs/
8484

8585
#### Prerequisites
8686

87-
Place `$HOME/.m2/settings.xml` with your Sonatype account information.
87+
* If you don't have `gnu-sed`, run `brew install gnu-sed` & `brew install gnupg`
88+
* Make sure you've set up your key https://central.sonatype.org/publish/requirements/gpg/
89+
* Make sure the account you are using has the permission to make releases [under com.slack groupId](https://central.sonatype.com/publishing/com.slack/users)
90+
91+
Place `$HOME/.m2/settings.xml` with your Sonatype account information.
92+
* Generate user token: https://central.sonatype.org/publish/generate-token/
93+
* Set the user token id/password: https://central.sonatype.org/publish/publish-manual/#signing-components
8894

8995
```xml
9096
<settings>
@@ -110,25 +116,31 @@ Place `$HOME/.m2/settings.xml` with your Sonatype account information.
110116

111117
#### Operations
112118

119+
* From the upstream repository
113120
* Preparation
114-
* `git pull --rebase slackapi master`
121+
* `git switch main && git pull origin main`
115122
* Make sure there are no build failures at https://github.com/slackapi/java-slack-sdk/actions
116123
* Set a new version
117-
* If you don't have `gnu-sed`, run `brew install gnu-sed` first
124+
* If you don't have `gnu-sed`, check out [Prerequisites](#prerequisites)
118125
* Run `scripts/set_version.sh (the version)` (e.g., `scripts/set_version.sh 1.0.0`)
119126
* Ship the libraries
120127
* Switch to **JDK 17** to publish all modules (on macOS, you can run `export JAVA_HOME=$(/usr/libexec/java_home -v 17)` for it)
121128
* Run `scripts/release.sh` (it takes a bit long)
122129
* (If you encounter an error, log in https://oss.sonatype.org/ to check detailed information)
123130
* Create GitHub Release(s) and add release notes
131+
* [Look at previous releases](https://github.com/slackapi/java-slack-sdk/releases) and follow their layouts
124132
* Prepare a release note by `git log --pretty=format:'%h %s by %an' --abbrev-commit | grep -v "Merge pull request " | head -50`
125133
* `git add . -v && git commit -m'version (your version here)'`
126134
* `git tag v(your version here)`
127-
* `git push slackapi --tags`
135+
* `git push & git push --tags`
128136
* Open https://github.com/slackapi/java-slack-sdk/releases/new?tag=v${version}
129137
* (Slack Internal) Communicate the release internally. Include a link to the GitHub Release(s).
130138
* (Slack Internal) Tweet? Not necessary for patch updates, might be needed for minor updates, definitely needed for
131139
major updates. Include a link to the GitHub Release(s).
140+
* Anticipate the next version as a SNAPSHOT
141+
* `scripts/set_version.sh (next patch version)-SNAPSHOT` (e.g., `scripts/set_version.sh 1.0.1-SNAPSHOT`)
142+
* `git add . -v && git commit -m 'Start next version'`
143+
* `git push`
132144

133145
## Workflow
134146

0 commit comments

Comments
 (0)