Update README auto documentation

debovema · Feb 13, 2018 · baf9cad · baf9cad
1 parent 63c5a23
commit baf9cad
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/release-trigger-branch/README.md b/release-trigger-branch/README.md
@@ -8,15 +8,15 @@ This branch is a release trigger. It means that **whenever a commit is pushed on
 
 ## How to trigger a release ?
 
-There is two different methods to trigger a release.
-They will both commit & push a change on this *release trigger branch* which will trigger a build on Gitlab CI.
+There are several methods to trigger a release.
+They will all commit & push a change on this *release trigger branch* which will trigger a build on Gitlab CI.
 
 ### automatically from Gitlab
 
 To trigger a new release with *$INCREMENT_POLICY* increment policy, simply [run a new pipeline]($GIT_REPOSITORY_URL_NO_EXT/pipelines/new) after selecting *$RELEASE_TRIGGER_BRANCH* in the list.
 That's it !
 
-### automatically
+### automatically from this repository
 
 * clone this repository:
 ```shell
@@ -37,7 +37,7 @@ chmod u+x ./release.sh
 
 This script will update the [*release.properties*](./release.properties) file with next versions (based on ```INCREMENT_POLICY``` set in [*release.properties*](./release.properties) and current version set in POM of branch $SOURCE_BRANCH) then commit and push this file on this *release trigger branch*, hence triggering a release.
 
-### setting manually the versions
+### manually
 
 * clone this repository:
 ```shell
@@ -70,6 +70,8 @@ git add release.properties && git commit -m "Triggering release $RELEASE_VERSION
 git push origin $RELEASE_TRIGGER_BRANCH
 ```
 
+These versions numbers can also be [edited directly in Gitlab]($GIT_REPOSITORY_URL_NO_EXT/edit/$RELEASE_TRIGGER_BRANCH/release.properties).
+
 ## Full documentation
 
 The full documentation for the Maven auto releaser v$MAVEN_AUTO_RELEASER_VERSION can be found at https://github.com/debovema/maven-auto-releaser/blob/$MAVEN_AUTO_RELEASER_VERSION_TAG/README.md.
diff --git a/release-trigger-branch/release.properties b/release-trigger-branch/release.properties
@@ -1,7 +1,8 @@
 # $PROJECT_NAME release properties
 
-DEV_VERSION=0.0.1-SNAPSHOT
+# set manually the version or leave 0.0.0 for automatic guessing
 RELEASE_VERSION=0.0.0
+DEV_VERSION=0.0.1-SNAPSHOT
 
 # Git user info
 GIT_USER_NAME="$GIT_USER_NAME"