Skip to content

Latest commit

 

History

History
103 lines (72 loc) · 4.44 KB

release-actions.md

File metadata and controls

103 lines (72 loc) · 4.44 KB

GitHub Reusable Workflow: Release Actions

Reusable workflow that performs actions and workflows release.

  • Generates readme for changed actions and workflows (documentation, versioning, etc.)
  • Commits and pushes the changes to the main branch

Usage

name: "Release Actions"

on:
  push:
    branches: [main]
    tags: ["*"]

permissions:
  contents: write

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  release:
    uses: hoverkraft-tech/ci-github-publish/.github/workflows/[email protected]
    with:
      # Json array of runner(s) to use.
      # See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>.
      runs-on: '["ubuntu-latest"]'

      # Update all actions and workflows, regardless of changes.
      update-all: false

      # GitHub App ID to generate GitHub token in place of private-access-token.
      # See <https://github.com/actions/create-github-app-token>.
      github-app-id: ""

    secrets:
      # GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write, workflows: write).
      # See <https://github.com/hoverkraft-tech/ci-github-common/blob/main/actions/create-and-merge-pull-request/README.md>.
      github-token: ""

      # GitHub App private key to generate GitHub token in place of github-token.
      # See <https://github.com/actions/create-github-app-token>.
      github-app-key: ""

Permissions

This workflow requires the following permissions:

  • contents: read: To read the contents of the repository

Secrets

Secret Description Default Required
github-token GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write, workflows: write). See https://github.com/hoverkraft-tech/ci-github-common/blob/main/actions/create-and-merge-pull-request/README.md. GITHUB_TOKEN false
github-app-key GitHub App private key to generate GitHub token in place of github-token. See https://github.com/actions/create-github-app-token. false

Inputs

Input Description Default Required
runs-on Json array of runner(s) to use. See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job. ["ubuntu-latest"] false
update-all Update all actions and workflows, regardless of changes. false false
github-app-id GitHub App ID to generate GitHub token in place of private-access-token. See https://github.com/actions/create-github-app-token. false