Skip to content

nrkno/github-workflow-semantic-release

Repository files navigation

Semantic Release workflow through Github Actions

Reusable Github workflow for linting commits and make releases using semantic-release

Usage

This workflow will use sensible defaults for commitlint and semantic-release

If you want to override the commitlint configuration, create a file in your repo named commitlint.config.js and this will be used instead of the default in this workflow.

If you want to override the semantic-release configuration, create a file in your repo named .releaserc.json and this will be used instead of the default in this workflow.

Reference for a workflow job:

permissions:
  contents: write
  pull-requests: write
  repository-projects: write

jobs:
  commitlint_and_release:
    name: Commit lint and release
    uses: nrkno/github-workflow-semantic-release/.github/workflows/workflow.yaml@v3
    with:
      # inputs
    secrets:
      # secrets

Inputs

  • release-enabled (boolean, default true)
  • lint-enabled (boolean, default true)
  • runs-on (string, default "ubuntu-latest")