Skip to content
tag

GitHub Action

boywithkeyboard/publisher

v3.0.1 Latest version

boywithkeyboard/publisher

tag

boywithkeyboard/publisher

An opinionated, production-ready release manager

Installation

Copy and paste the following snippet into your .yml file.

              

- name: boywithkeyboard/publisher

uses: boywithkeyboard-archive/publisher@v3.0.1

Learn more about this action in boywithkeyboard-archive/publisher

Choose a version

Usage

  1. Make sure you have a changelog.md or CHANGELOG.md file in the root directory of your repository that is similar to this one:

    ## [v1.1.0](https://github.com/user/repository/releases/tag/v1.1.0)
    
    Some release notes.
    
    ## [v1.0.0](https://github.com/user/repository/releases/tag/v1.0.0)
    
    Some more release notes.
    
  2. Create a new workflow file with the following content:

    name: publish
    
    on:
      push:
        tags:
          - v*
    
    jobs:
      publish:
        runs-on: ubuntu-latest
    
        steps:
          - uses: actions/checkout@v4
    
          - name: Publish Release
            uses: boywithkeyboard/publisher@v3
  3. To trigger the workflow, simply push a new tag.

Configuration

  • tag (context.ref by default)

    The tag name for the new release.

  • draft (false by default)

    Create the new release as a draft.

  • prerelease (false by default)

    Create the new release as a pre-release.

  • token ($GITHUB_TOKEN by default)

    The access token to use for creating the new release.