Skip to content

release-actions.md

Latest commit

 

History

History
169 lines (114 loc) · 6.31 KB

release-actions.md

File metadata and controls

169 lines (114 loc) · 6.31 KB

GitHub Reusable Workflow: Release Actions

Release Actions

Release License Stars PRs Welcome

Overview

Reusable workflow that detects changed GitHub Actions and workflow files, generates or updates their readme documentation (including version updates), and publishes the resulting documentation changes back to the repository.

Key behaviors:

  • Detect changed actions and workflows (or optionally update all).
  • Generate documentation files for each changed Action/workflow
  • Commit and push documentation updates (via a pull request.
  • Publish documentation to GitHub Pages on push to default branch.

Permissions

  • contents: read

Usage

name: Release Actions
on:
  push:
    branches:
      - main
permissions: {}
jobs:
  release-actions:
    uses: hoverkraft-tech/ci-github-publish/.github/workflows/release-actions.yml@48e0c54489152b98d9e18f0454ccce120e9d0fd1 # 0.23.0
    permissions:
      contents: read
    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: ""
    with:
      # JSON array of runner(s) to use.
      # See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.
      #
      # Default: `["ubuntu-latest"]`
      runs-on: '["ubuntu-latest"]'

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

      # List of extra documentation files to update (if any).
      documentation-files: ""

      # GitHub App Client ID to generate GitHub token in place of github-token.
      # See https://github.com/actions/create-github-app-token.
      github-app-client-id: ""

Inputs

Workflow Call Inputs

Input Description Required Type Default
runs-on JSON array of runner(s) to use. false string ["ubuntu-latest"]
See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.
update-all Update all actions and workflows, regardless of changes. false boolean false
documentation-files List of extra documentation files to update (if any). false string -
github-app-client-id GitHub App Client ID to generate GitHub token in place of github-token. false string -
See https://github.com/actions/create-github-app-token.

Secrets

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

Outputs

Output Description
artifact-id ID of the uploaded artifact containing generated documentation.

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

License

This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2026 hoverkraft-tech

For more details, see the license.

This documentation was automatically generated by CI Dokumentor.