Table of Contents

• Inputs
  • github-token
  • protected-branch
  • allowed-branch
• Example of usage
• Example using a custom branches
• Development
  • Close release
  • Documentation

Inputs

github-token

Required The github token to comment in the PR.

protected-branch

The name of the protected branch

allowed-branch

The name of the branch allowed to merge over the protected branch

Example of usage

uses: raulanatol/[email protected]
with:
  github-token: ${{ secrets.GITHUB_TOKEN }}

Example using a custom branches

.github/workflows/main.yml

on: pull_request

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: raulanatol/[email protected]
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        protected-branch: production
        allowed-branch: stage

Development

Close release

To close a release you only need to execute the makefile with release_{major|minor|patch}

Example:

make release_minor

Documentation

To generate the documentation you only need to execute the makefile with docs.

Using doctoc

make docs