https://github.com/nnichols/maven-version-bump-action

A simple GitHub Actions to bump the version of Maven projects
https://github.com/nnichols/maven-version-bump-action

action clojure java maven-pom pom

Last synced: 3 months ago
JSON representation

A simple GitHub Actions to bump the version of Maven projects

• Host: GitHub
• URL: https://github.com/nnichols/maven-version-bump-action
• Owner: nnichols
• License: mit
• Created: 2021-01-07T13:38:11.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-02-20T16:49:10.000Z (12 months ago)
• Last Synced: 2024-11-09T04:46:28.213Z (3 months ago)
• Topics: action, clojure, java, maven-pom, pom
• Language: Shell
• Homepage:
• Size: 15.6 KB
• Stars: 7
• Watchers: 2
• Forks: 34
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Maven Version Bump Action

A simple GitHub Actions to bump the version of Maven projects.

When triggered, this action will look at the commit message of HEAD~1 and determine if it contains one of `#major`, `#minor`, or `#patch` (in that order of precedence).

If true, it will use Maven to bump your pom's version.

You can override this default behavior by setting a release type, setting type will override the above commit message check.

For example, a `#minor` update to version `1.3.9` will result in the version changing to `1.4.0`.

The change will then be committed.

## Sample Usage

```yaml

name: Clojure Version Bump

on: [push]

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - name: Checkout Latest Commit

      uses: actions/checkout@v2

    - name: Bump Version

      id: bump

      uses: nnichols/maven-version-bump-action@v3

      with:

        github-token: ${{ secrets.github_token }}

    - name: Print Version

      run: "echo 'New Version: ${{steps.bump.outputs.version}}'"

```

## Supported Arguments

* `github-token`: The only required argument. Can either be the default token, as seen above, or a personal access token with write access to the repository

* `git-email`: The email address each commit should be associated with. Defaults to a github provided noreply address

* `git-username`: The GitHub username each commit should be associated with. Defaults to `github-actions[bot]`

* `type`: This will overide the release type this can  be minor, patch or major. if not set will use comments.

* `pom-path`: The path within your directory the pom.xml you intended to change is located.

## Outputs

* `version` - The after-bump version. Will return the old version if bump was not necessary.

## Licensing

Copyright © 2021-2022 [Nick Nichols](https://nnichols.github.io/)

Distributed under the [MIT License](https://github.com/nnichols/maven-version-bump-action/blob/master/LICENSE)