Skip to content

Latest commit

 

History

History
78 lines (61 loc) · 3.14 KB

README.md

File metadata and controls

78 lines (61 loc) · 3.14 KB
Raw

GitHub Action Semantic Release

Description

GitHub Action for Semantic Release

Configuration

Step1: Set any Semantic Release Configuration in your repository.

Step2: Add Secrets in your repository for the Semantic Release Authentication Environment Variables.

Step3: Add a Workflow File to your repository to create custom automated processes.

Usage

name: Semantic Release

on:
  push:
    branches: [main]

jobs:
  semantic-release:
    name: Release
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - uses: open-turo/actions-release/semantic-release@v3
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}

Inputs

parameter description required default
github-token GitHub token that can checkout the repository as well as create tags/releases against it. e.g. 'secrets.GITHUB_TOKEN' true ${{ github.token }}
branches Override the branches where semantic release runs on. Accepts a string or a JSON object. false
ci Set to false to skip Continuous Integration environment verifications false
dry-run Whether to run semantic release in dry-run mode. It will override the dryRun attribute in your configuration file false
extra-plugins Extra plugins for pre-install. You can also specify specifying version range for the extra plugins if you prefer. false
semantic-version Specify what version of semantic release to use false
override-github-ref-name Allow for override of github ref-name for running pull and repository dispatch triggered events false

Outputs

parameter description
new-release-published Whether a new release was published
new-release-notes The release notes for the new release if any
new-release-version Version of the new release
new-release-major-version Major version of the new release
new-release-minor-version Minor version of the new release
new-release-patch-version Patch version of the new release
new-release-type Type of the new release: 'prerelease'
last-release-version Version of the last release
last-release-major-version Major version of the last release

Runs

This action is a composite action.