Skip to content

Commit ec1ebb5

Browse files
committed
docs: updated RELEASE.md
1 parent 6d7d038 commit ec1ebb5

1 file changed

Lines changed: 27 additions & 28 deletions

File tree

‎RELEASE.md‎

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,40 @@ Releases are published to GitHub and Maven Central by JReleaser from a version t
88
- Push access to the `codejive/java-properties` repository.
99
- A Maven Central publisher account and namespace for `org.codejive`.
1010
- An armored GPG key configured in the repository's `jreleaser` environment:
11-
`JRELEASER_GPG_PUBLIC_KEY`, `JRELEASER_GPG_SECRET_KEY`, and
12-
`JRELEASER_GPG_PASSPHRASE`.
11+
`GPG_PUBLIC_KEY`, `GPG_SECRET_KEY`, and `GPG_PASSPHRASE`.
1312
- The `MAVENCENTRAL_USERNAME` and `MAVENCENTRAL_PASSWORD` secrets.
1413
- The workflow-provided `GITHUB_TOKEN` permission to create releases.
1514

16-
## Creating a Release
15+
## Creating a Release from GitHub.com
16+
17+
1. Open [github.com/codejive/java-properties/actions](https://github.com/codejive/java-properties/actions).
18+
2. Select **Release** in the workflow list.
19+
3. Click **Run workflow**.
20+
4. Leave the branch set to `main` and enter the release version without a leading
21+
`v`, for example `0.0.8`.
22+
5. Click **Run workflow** to start the release.
23+
6. Open the newly created workflow run and wait for the `release` job to complete.
24+
7. Open [github.com/codejive/java-properties/releases](https://github.com/codejive/java-properties/releases)
25+
and verify the new GitHub release and its generated changelog.
26+
8. Verify that the component has been published to Maven Central.
27+
28+
The workflow uses the `jreleaser` environment, so GitHub may pause the job until
29+
any required environment approval is granted.
30+
31+
## Creating a Release from a Tag
1732

1833
1. Ensure the changes are committed and the CI workflow is green.
1934
2. Create and push an annotated tag whose name is the release version, for example:
2035

21-
```shell
22-
git tag -a v0.0.8 -m "Release v0.0.8"
23-
git push origin v0.0.8
24-
```
36+
```shell
37+
git tag -a v0.0.8 -m "Release v0.0.8"
38+
git push origin v0.0.8
39+
```
2540

2641
3. The `Release` workflow sets the Maven version from the tag, builds the sources and
27-
Javadoc artifacts, and runs JReleaser.
42+
Javadoc artifacts, and runs JReleaser.
2843
4. Verify the GitHub release and the published component on Maven Central.
2944

30-
The workflow can also be started manually from GitHub Actions. In that case, provide
31-
the version without the leading `v`.
32-
3345
## Local Configuration Check
3446

3547
This validates the JReleaser configuration without publishing anything:
@@ -49,20 +61,7 @@ signing keys remain outside the local environment.
4961
5062
## Recovery
5163
52-
```
53-
./mvnw jreleaser:full-release
54-
```
55-
56-
Re-running the workflow for the same tag is safe because the JReleaser GitHub release
57-
configuration allows overwriting an existing release. If a release must be corrected,
58-
fix the source, create a new patch version, and push a new tag.
59-
60-
```
61-
mvn -B release:update-versions -DdevelopmentVersion=1.2.3-SNAPSHOT
62-
```
63-
64-
A manual deploy can be done like this:
65-
66-
```
67-
mvn clean deploy -P release
68-
```
64+
If a workflow fails, open its run in **Actions**, inspect the failed step, correct the
65+
underlying issue, and use **Re-run failed jobs**. If the release must be corrected
66+
after publication, fix the source, choose a new patch version, and run the workflow
67+
again from GitHub.com.

0 commit comments

Comments
 (0)