Skip to content

Commit 3b90774

Browse files
p4trickweissWeltraumschaf
authored andcommitted
#132 update release docs
Signed-off-by: Patrick <[email protected]>
1 parent b603b95 commit 3b90774

File tree

1 file changed

+4
-10
lines changed

1 file changed

+4
-10
lines changed

docs/release.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Here we describe all the ceremonial stuff necessary to publish a Java library to
44

55
## How to Perform a Release
66

7-
The whole release process is automated by a [GitHub action workflow](https://github.com/secureCodeBox/defectdojo-client-java/actions) which utilizes the [Maven release plugin](https://maven.apache.org/maven-release/maven-release-plugin/). Since we need the possibility to set custom versions (e.g. 2.0.0-beta) we can not use a simple one-push-button solution. Instead, we utilize en event triggered workflow to achieve this. The release process is as following:
7+
The whole release process is automated by a [GitHub action workflow](https://github.com/secureCodeBox/defectdojo-client-java/actions) which utilizes the [Maven Plugin](https://central.sonatype.org/publish/publish-portal-maven/). Since we need the possibility to set custom versions (e.g. 2.0.0-beta) we can not use a simple one-push-button solution. Instead, we utilize en event triggered workflow to achieve this. The release process is as following:
88

99
First go to the "Actions" tab and select the "Publish Release" workflow:
1010

@@ -28,7 +28,7 @@ Typically, a release by Maven simply means:
2828

2929
- Remove the "-SNAPSHOT" qualifier from the version in the `pom.xml`. E.g. "1.0.0-SNAPSHOT" will become "1.0.0".
3030
- Build everything, make a commit with this version and tag this version.
31-
- Upload the resulting artifacts to [Sonatype Nexus](https://oss.sonatype.org/) and stage them.
31+
- Upload the resulting artifacts to [Maven Central](https://central.sonatype.com/) and stage them.
3232
- Increment to next development version in `pom.xml`. In this example "1.0.1-SNAPSHOT".
3333
- Build everything and make a commit.
3434

@@ -39,15 +39,9 @@ In the case you want to publish a custom release, e.g. a "1.0.2-beta", it is nec
3939

4040
![](release_05_custom-version.png)
4141

42-
### Additional Information About the Release Process
43-
44-
After the first release a [bot created the Maven Central sync][ossrh-jira-issue]:
45-
46-
> Central sync is activated for io.securecodebox. After you successfully release, your component will be available to the public on Central https://repo1.maven.org/maven2/, typically within 30 minutes, though updates to https://search.maven.org can take up to four hours.
47-
4842
## Credentials
4943

50-
Publishing to Maven Central requires authentication in the form of username and password or user token (as username and password). We use [user tokens][user-token] for authentication, which are stored in our password manager.
44+
Publishing to Maven Central requires authentication in the form of username and password or user token (as username and password). We use [user tokens](https://central.sonatype.org/publish/generate-portal-token/) for authentication, which are stored in our password manager.
5145

5246
### Local (on device)
5347

@@ -139,7 +133,7 @@ gpg> expire
139133
```shell
140134
gpg> save
141135
```
142-
6. Update the private key in out password manager and GitHub Secrets
136+
6. Update the private key in our password manager and GitHub Secrets
143137

144138
[gh-secrets]: https://www.theserverside.com/blog/Coffee-Talk-Java-News-Stories-and-Opinions/GitHub-Actions-Secrets-Example-Token-Tutorial
145139
[user-token]: https://help.sonatype.com/iqserver/managing/user-management/user-tokens

0 commit comments

Comments
 (0)