Skip to content

Commit 5263cf4

Browse files
Documented release steps
1 parent c5fa5c9 commit 5263cf4

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

RELEASE.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Howto Release
2+
3+
## Perform a release
4+
5+
Release are uploaded to a staging repository of [Maven Central](https://search.maven.org):
6+
7+
```bash
8+
# perform release (use `git reset --hard origin/master` and delete tags to retry)
9+
mvn release:clean
10+
mvn release:prepare
11+
mvn release:perform
12+
```
13+
14+
Then visit [oss.sonatype.org](https://oss.sonatype.org) in order to deploy the release.
15+
16+
It takes up to 2 hours until the release appears at [Maven Central](https://search.maven.org/#search%7Cga%7C1%7Cvavr-beanvalidation2). The public repository can be found [here](https://repo.maven.apache.org/maven2/io/vavr/vavr-beanvalidation2).
17+
18+
## Best practice: Remove an existing release from Git
19+
20+
Sometime something goes wrong during a release. Here are some steps to restore the previous state.
21+
22+
Given a **<version>** (e.g. 0.9.2), a _non-published_ release can be removed like this:
23+
24+
```bash
25+
# get actual master
26+
git clone https://github.com/vavr-io/vavr-beanvalidation2.git ; vavr-beanvalidation2
27+
28+
# delete existing tag (local and remote)
29+
git tag -d v<version>
30+
git push --delete origin v<version>
31+
32+
# revert development version
33+
mvn versions:set -DnewVersion=<version>-SNAPSHOT
34+
git commit -a -m "Reverted to <version>-SNAPSHOT"
35+
git push origin master ; git pull
36+
```

0 commit comments

Comments
 (0)