Skip to content

Commit

Permalink
Improve releasing section in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
liry committed Nov 1, 2022
1 parent 621f28a commit 6402816
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,18 +43,26 @@ mvn clean package assembly:single

Resulting archive: `target/GlacierUploader-*-jar-with-dependencies.jar`

#### Perform release in SCM (GIT)
#### Perform release of new version
Double check you are in the master branch with the latest changes pulled. Also check that `CHANGELOG.md` contains info
about the release to be done.

This will do some checks, change the version in the POM to a new version (you will be prompted for the versions to use),
commit POM, tag the code in the SCM, bump the version in the POM and commit+push this POM.
One can first simulate the release (with no changes in SCM) using parameter `-DdryRun=true`.
```
mvn release:prepare
```

This will do some checks, change the version in the POM to a new version (you will be prompted for the versions to use),
commit POM, tag the code in the SCM, bump the version in the POM and commit this POM.

One can first simulate the release (with no changes in SCM) using parameter `-DdryRun=true`.
Then, switch to just created release tag
```
git checkout GlacierUploader-X.Y.Z
```
and build the runnable JAR (see above) from there, to be attached to the release in the GitHub.

Also do not forget to update `CHANGELOG.md`, add [release](https://github.com/SimpleAmazonGlacierUploader/SAGU/releases)
and [update website](https://github.com/SimpleAmazonGlacierUploader/SimpleAmazonGlacierUploader.github.io).
Also do not forget to create [GitHub Release](https://github.com/SimpleAmazonGlacierUploader/SAGU/releases) with
runnable JAR in assets and [update website](
https://github.com/SimpleAmazonGlacierUploader/SimpleAmazonGlacierUploader.github.io).

#### Bulk bump of dependency versions
```
Expand Down

0 comments on commit 6402816

Please sign in to comment.