Skip to content

Commit 902e45a

Browse files
kiviewbsideuprnorth
authored
Update RELEASING.md (#4590)
Co-authored-by: Sergei Egorov <[email protected]> Co-authored-by: Richard North <[email protected]>
1 parent 1469b22 commit 902e45a

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

RELEASING.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,21 @@ Testcontainers' release process is semi-automated through GitHub Actions. This d
66

77
1. Ensure that the master branch is building and that tests are passing.
88
1. Create a new release on GitHub. **The tag name is used as the version**, so please keep the tag name plain (e.g. 1.2.3).
9-
1. The release triggers a GitHub Action workflow, but it gets mostly build using results from the Gradle remote-cache. Therefore, this should be fairly fast.
10-
1. Login to Sonatype to check the staging repository.
11-
1. Get the staging url after GitHub Action workflow finished.
12-
1. Manually test the release with the staging url as maven repository url (e.g. critical issues and features).
13-
1. Run [TinSalver](https://github.com/bsideup/tinsalver) from GitHub using `npx` to sign artifact (see [TinsSalver README](https://github.com/bsideup/tinsalver/blob/main/README.md)).
14-
1. Close the release in Sonatype. This will evaluate the release based on given Sontaype rules and afterwards automatically sync to Maven Central.
15-
1. Handcraft and polish some of the release notes (e.g. substitute combinded dependency PRs and highlight certain features).
16-
1. When available through Maven Central, poke [Richard North](https://github.com/rnorth) to announce the release on Twitter!
9+
1. The release triggers a GitHub Action workflow.
10+
1. Log in to [Sonatype](https://oss.sonatype.org/) to check the staging repository.
11+
* Getting access to Sonatype requires a Sonatype JIRA account and [raising an issue](https://issues.sonatype.org/browse/OSSRH-74229), requesting access.
12+
3. Get the staging URL from Sonatype after GitHub Action workflow finished. The general URL format should be `https://oss.sonatype.org/service/local/repositories/$staging-repo-id/content/`
13+
4. Manually test the release with the staging URL as maven repository URL (e.g. critical issues and features).
14+
5. Run [TinSalver](https://github.com/bsideup/tinsalver) from GitHub using `npx` to sign artifact (see [TinSalver README](https://github.com/bsideup/tinsalver/blob/main/README.md)).
15+
* For TinSalver to correctly work with keybase on WSL on Windows, you might need to disable pinentry: `keybase config set -b pinentry.disabled true`.
16+
7. Close the release in Sonatype. This will evaluate the release based on given Sonatype rules.
17+
8. After successful closing, the release button needs to be clicked and afterwards it is automatically synced to Maven Central.
18+
9. Handcraft and polish some of the release notes (e.g. substitute combinded dependency PRs and highlight certain features).
19+
10. When available through Maven Central, poke [Richard North](https://github.com/rnorth) to announce the release on Twitter!
1720

1821
## Internal details
1922

2023
* The process is done with GitHub Actions, TinSalver and Sonatype.
2124
* Sonatype will automatically promote the staging release to Maven Central.
2225
* Keybase needs to be installed on the developer machine.
23-
* GPG key of signing developer needs to be uplodaed to the Ubuntu keyserver (or other server supported by Sonatype).
26+
* GPG key of signing developer needs to be uplodaed to the [Ubuntu keyserver](https://keyserver.ubuntu.com/) (or other server supported by Sonatype).

0 commit comments

Comments
 (0)