dev-build-deploy/ReleaseMe - GitHub Release Management
Managing GitHub releases using Conventional Commits.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| token | GitHub token used to access GitHub (eg. github.token) | no | — |
| prefix | Prefix used for the version (eg. v) | no | — |
| config | Path to the Release configuration file, defaults to .github/release.yml | no | .github/release.yml |
| artifacts | Multiline list of artifact names, uploaded as part of the current workflow run, to upload as a GitHub Release asset | no | — |
| files | Multiline list of files (paths) to upload as a GitHub Release asset | no | — |
| versioning | Versioning scheme to apply | no | semver |
| draft | Draft GitHub Release instead of publishing it | no | false |
| release-notes | External Release Notes file to include in the GitHub Release | no | — |
| increment-type | Increment type to apply to the version | no | — |
| version | Version to associate with the GitHub Release | no | — |
| paths | Multiline list of glob patterns. When set, only commits touching matching paths are considered for the version increment and changelog. Overrides `paths` declared in the config file. | no | — |
| create-release | Create the GitHub Release, can be set to `false` to perform a dry run (i.e. determine the previous and incremented version) | no | true |
Outputs
| name | description |
|---|---|
| created | Boolean indicating if a release was created |
| release | JSON object containing the release information |