Skip to content

Commit 0f6b143

Browse files
committed
Update README for release changes missed in the previous commit.
Signed-off-by: James R. Perkins <jperkins@ibm.com>
1 parent ce81783 commit 0f6b143

1 file changed

Lines changed: 49 additions & 5 deletions

File tree

README.adoc

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,58 @@ See the link:CONTRIBUTING.adoc[contributing guide].
2929

3030
== Releasing
3131

32-
Releasing this project requires access to https://repository.jboss.org/nexus[JBoss Nexus].
32+
Releasing the project requires permission to deploy to Maven Central see https://central.sonatype.org/publish/requirements/[Maven Central Release Requirements].
33+
Once everything is setup, you simply need to run the `./release.sh` script. There are two required parameters:
3334

34-
To perform a release ensure you're on the correct branch and that branch is up to date. Once done you can simply use
35-
the `release.sh` bash script.
35+
1. `-r` or `--release` which is the version you want to release
36+
2. `-d` or `--development` which is the next development version.
37+
38+
By default, the release version cannot contain `SNAPSHOT` and the development version, must contain `SNAPSHOT`.
3639

3740
[source,bash]
41+
.Example Command
3842
----
39-
./release.sh -r 2.0.2.Final -d 2.0.3.Final-SNAPSHOT
43+
./release.sh -r 1.0.0.Final -d 1.0.1.Final-SNAPSHOT
4044
----
4145

42-
If this was successful, instructions will be printed on the console with the next set of instructions for processing.
46+
=== Supported Arguments
47+
48+
|===
49+
|Argument | Requires Value | Description
50+
51+
| `-d`, `--development`
52+
| Yes
53+
| The next version for the development cycle.
54+
55+
| `-f`, `--force`
56+
| No
57+
| Forces to allow a SNAPSHOT suffix in release version and not require one for the development version.
58+
59+
| `-h`, `--help`
60+
| N/A
61+
| Displays this help
62+
63+
| `--notes-start-tag`
64+
| Unused
65+
| Passes the `--notes-from-tag` and the argument to the `gh create release` command.
66+
67+
| `-p`, `--prerelease`
68+
| Unused
69+
| Passes the `--prerelease` to the `gh create release` command.
70+
71+
| `-r`, `--release`
72+
| Yes
73+
| The version to be released. Also used for the tag.
74+
75+
| `--dry-run`
76+
| No
77+
| Executes the release in as a dry-run. Nothing will be updated or pushed.
78+
79+
| `-v`, `--verbose`
80+
| No
81+
| Prints verbose output.
82+
83+
|===
84+
85+
86+
Any additional arguments are considered arguments for the Maven command.

0 commit comments

Comments
 (0)