Skip to content

Commit

Permalink
Clarify the patch version number property
Browse files Browse the repository at this point in the history
  • Loading branch information
qcastel committed Jan 20, 2022
1 parent 88522b1 commit 1931035
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
FROM qcastel/maven-release:0.0.34
FROM qcastel/maven-release:0.0.35

COPY ./release-github-actions.sh /usr/local/bin
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -294,9 +294,7 @@ If for a reason, you need to skip the maven release perfom, you can disable it a
```


### Increase major or minor version
By default, maven release will increase the patch version. If you are interested to actually increment the major or minor version, you can use
the following options:
### Increase major, minor or patch version

#### For major version increment

Expand All @@ -315,6 +313,20 @@ _1.0.0-SNAPSHOT -> 1.2.0-SNAPSHOT_
with:
version-minor: true
```

#### For patch version increment

As the patch version is the default version number increased, you don't need to specify any additional properties.

Although if you prefer to be explicit, you can use the following option:

_1.0.0-SNAPSHOT -> 1.0.1-SNAPSHOT_

```yaml
with:
version-patch: true
```

### Customize version

#### development version
Expand Down
5 changes: 5 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,10 @@ inputs:
description: 'Increment the minor version number'
required: false
default: false
version-patch:
description: 'Increment the patch version number <- By default, we will increase the patch version'
required: false
default: false

m2-home-folder:
description: 'M2 home folder'
Expand Down Expand Up @@ -160,5 +164,6 @@ runs:

VERSION_MAJOR: ${{ inputs.version-major }}
VERSION_MINOR: ${{ inputs.version-minor }}
VERSION_PATCH: ${{ inputs.version-patch }}

RELEASE_BRANCH_NAME: ${{ inputs.release-branch-name }}

0 comments on commit 1931035

Please sign in to comment.