README.md

Caretaker

Inputs

Name	Required	Default Value	Details
git-push-user-name	false	github-actions[bot]	The name of the person used for the git commit.
git-push-user-email	false	github-actions[bot]@users.noreply.github.com	The email used for the git commit. Required if using GPG.
git-commit-message	false	chore: caretaker action	The commit message to use.
gpg-passphrase	false		Passphrase for the GPG key.
gpg-private-key	false		GPG private key for signing the published artifacts.
output-file	false	CHANGELOG.md	The name of the changelog file.
args	false		Additional arguments to pass to the command.

args are currently silently ignored

Example usage

Basic

The following configuration will run caretaker and commit the new changelog to the master branch, however this commits will be unsigned.

name: Caretaker

on:
  push:
    branches:
      - master
    tags:
      - 'v*'

jobs:
  caretaker:
    runs-on: ubuntu-latest
    name: Caretaker
    steps:
      - name: Check our repo
        uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Caretaker
        uses: ActionsToolbox/caretaker-action@master

Signed Comiits

The following configuration will do exactly the same as the basic example onlt this time the commits will be signed.

Never use your personal GPG keys for automated tools, create one that is dedicated for this purpose!

name: Caretaker

on:
  push:
    branches:
      - master
    tags:
      - 'v*'

jobs:
  caretaker:
    runs-on: ubuntu-latest
    name: Caretaker
    steps:
      - name: Check our repo
        uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Caretaker
        id: caretaker
        uses: ActionsToolbox/caretaker-action@master
        with:
          gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
          gpg-passphrase: ${{ secrets.GPG_PASSPHRASE }}
          git-push-user-email: ${{ secrets.GPG_EMAIL }}