Skip to content

Commit

Permalink
bump
Browse files Browse the repository at this point in the history
  • Loading branch information
mateothegreat committed Jul 10, 2022
1 parent 68b07c3 commit 244076a
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,20 @@

GitHub action to auto-magically perform semantic version bumps and create releases.

* Doesn't use some hacky `git` subshell commands (straight to the REST API baby!) 👏👏👏
* Creates a new tag off of specified branch using semantic versioning.
* Creates a new release based on new tag with notes.

![screenshot](screenshot.png)

## Inputs

* `owner` __(required)__ - string - The owner of your repository (username or organization name).
* `repo` __(required)__ - string - The name of your repository.
* `increment` __(required)__ - string - Increment based on major, minor, or release.
* `default` (optional) - string - The default tag if there are no tags (defaults to 0.0.0).
* `prefix` (optional) - string - Prefix to add to the semantic version value (defaults to none).
* `branch` (optional) - string - Branch to base tag off of (defaults to main).
* `release_name` (optional) - string - Name of the release (defaults to the new version).
* `release_body` (optional) - string - Body of the release.
* `release_notes` (optional) - boolean - Automatically generate release notes for the release (it will be appended to
Expand Down Expand Up @@ -48,8 +56,8 @@ jobs:
uses: mateothegreat/action-release@main
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
owner: mateothegreat
repo: action-release
owner: youreawesome
repo: nuts-and-bolts
increment: patch
committer_name: Matthew Davis
committer_email: [email protected]
Expand Down Expand Up @@ -80,9 +88,12 @@ jobs:
uses: mateothegreat/action-release@main
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
owner: mateothegreat
repo: action-release
owner: youreawesome
repo: nuts-and-bolts
increment: patch
default: v0.0.0
prefix: v
branch: main
release_name: MVP release 🎉
release_body: |
This is the body of the release.
Expand Down
6 changes: 6 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,15 @@ inputs:
default:
required: false
description: "The default tag if there are no tags (defaults to 0.0.0)."
prefix:
required: false
description: "Prefix to add to the semantic version value (defaults to none)."
increment:
required: true
description: "Increment based on major, minor, or release."
branch:
required: false
description: "Branch to base tag off of (defaults to main)."
release_name:
required: false
description: "Name of the release (defaults to the new version)."
Expand Down
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 244076a

Please sign in to comment.