Skip to content

Commit 201a441

Browse files
authored
docs: Update releasing-curator.md
1 parent 6a7ed53 commit 201a441

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

community/releasing-curator.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,23 @@ To release Curator, the following steps must be followed:
1313

1414
## Prepare the Release
1515

16-
1. Do a dry run of the release/prepare step by executing `mvn -P apache-release release:prepare -DdryRun=true`. The dry run will not commit any changes back to Git and gives you the opportunity to verify that the release process will complete as expected. If you need to cancel, execute `mvn release:clean` and then reset via `git reset --hard`.
16+
1. Do a dry run of the release/prepare step by executing `./mvnw -P apache-release release:prepare -DdryRun=true`. The dry run will not commit any changes back to Git and will allow you to verify that the release process will be completed as expected. If you need to cancel, execute `./mvnw release:clean` and then reset via `git reset --hard`.
1717
2. Verify that the release process completed as expected:
18-
* The release plugin will create `pom.xml.tag` files which contain the changes that would have been committed to SVN. The only differences between `pom.xml.tag` and its corresponding `pom.xml` file should be the version number.
19-
* If other formatting changes have been made you should review the changes and then commit and push them.
20-
* Once any failures or required updates have been committed to svn, rollback the release prepare files: `mvn release:rollback`
18+
* The release plugin will create `pom.xml.tag` files, which contain the changes that would have been committed to SVN. The only difference between `pom.xml.tag` and its corresponding `pom.xml` file should be the version number.
19+
* If other formatting changes have been made, you should review the changes and then commit and push them.
20+
* Once any failures or required updates have been committed to svn, rollback the release prepare files: `./mvnw release:rollback`
2121
3. Execute the release/prepare step for real this time
2222
* You'll be prompted for the same version information and optionally your GPG
2323
* passphrase again
24-
* mvn -P apache-release release:prepare
25-
* mvn -P apache-release release:perform
26-
* git push --tags
24+
* `./mvnw -P apache-release release:prepare`
25+
* `./mvnw -P apache-release release:perform`
26+
* `git push --tags`
2727
4. Verify the staged artifacts in the Apache Nexus repository:
2828
* Go to: https://repository.apache.org/index.html
2929
* Login
30-
* Select Staging Repositories under the Build Promotion section on the left hand side
30+
* Select Staging Repositories under the Build Promotion section on the left-hand side
3131
* Select the repository from the main window
32-
* Select the content tab at the bottom of the screen and navigate through the artifact tree and double check things.
32+
* Select the content tab at the bottom of the screen and navigate through the artifact tree and double-check things.
3333
5. Close the Nexus staging repo by clicking on the curator repo and clicking the "Close" button.
3434

3535
:::caution
@@ -40,12 +40,12 @@ DO NOT release the binaries yet.
4040

4141
## Stage the Apache Release
4242

43-
1. At the root of your Curator directory, find the target directory.
44-
2. In the directory you will now find 3 files that need to be staged:
43+
1. At the root of your Curator directory, find the `target` directory.
44+
2. In the directory, you will now find 3 files that need to be staged:
4545
* apache-curator-X.X.X-source-release.zip
4646
* apache-curator-X.X.X-source-release.zip.asc
4747
* apache-curator-X.X.X-source-release.zip.sha512
48-
3. These files must be put into the staging directory (svn co https://dist.apache.org/repos/dist/dev/curator/)
48+
3. These files must be put into the staging directory (`svn co https://dist.apache.org/repos/dist/dev/curator/`)
4949
* Create a directory for the release
5050
* `cp` the files to this directory
5151
* Remove any old release directories via: `svn rm`

0 commit comments

Comments
 (0)