martinku-wynd / release-me

GitHub Release Management

ReleaseMe - GitHub Release Management

A GitHub Action to automate release management using GitHub Releases;

Features

• Creation of GitHub Releases with automatic version increments:
  • Semantic Versioning with Conventional Commits
  • Calendar Versioning using YYYY.0M.MICRO format.
• Straightforward release branching support
• Management of GitHub Release assets
• Configurable changelog
• Accessing GitHub Release information

Basic Usage

name: GitHub Release

concurrency: deployment

on:
  push:
    branches:
      - main
      - release/*

permissions:
  contents: write

jobs:
  release-me:
    name: Create GitHub Release
    runs-on: ubuntu-latest
    steps:
      - name: Run ReleaseMe
        id: release
        uses: dev-build-deploy/release-me@v0
        with:
          token: ${{ github.token }}
          prefix: v                    # OPTIONAL; prefixes the version with v (e.g. v1.0.0)
          config: .github/release.yml  # OPTIONAL; path to a Release configuration
          versioning: semver           # OPTIONAL; either `semver` or `calver`
          files: |                     # OPTIONAL; multiline list of local files names to upload as GitHub Release assets
            build.log
            dependencies.json
          artifacts: |                 # OPTIONAL; multiline list of build artifacts to upload as GitHub Release assets
            SBOM

      - if: ${{ steps.release.outputs.created }}
        run: echo ${{ fromJSON(steps.release.outputs.release).tag_name }}

Inputs

Key	Required	Description
token	YES	GitHub token used to access GitHub
prefix	NO	Prefix for the version, MUST be one of [A-Za-z0-9-.]
config	NO	Path to the Release configuration, defaults to .github/release.yml
artifacts	NO	Multiline list of artifact names, uploaded as part of the current workflow run, to upload as a GitHub Release asset
files	NO	Multiline list of files (paths) to upload as a GitHub Release asset
versioning	NO	Versioning strategy to apply. MUST be one of semver or calver. Default: semver

Outputs

Key	Description
created	Set to true when a release was created, otherwise the output is not set
release	Release object containing relevant information about the created release. Only set when created is set to true.

Permissions

Permission	Value	Description
contents	write	Required to create new GitHub Releases (and push tags)

Contributing

If you have suggestions for how release-me could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

License

• MIT © 2023 Kevin de Jong <[email protected]>