Skip to content

release.md

Latest commit

 

History

History
124 lines (91 loc) · 5.46 KB

release.md

File metadata and controls

124 lines (91 loc) · 5.46 KB

GitHub Workflow: Release

Release

Release License Stars PRs Welcome

Overview

Reusable release workflow This workflow delegates release tasks by reusing a shared release workflow, ensuring standardized publishing across projects.

Permissions

  • contents: write
  • id-token: write
  • pull-requests: read

Usage

name: Release
on:
  push:
    branches:
      - main
permissions: {}
jobs:
  release:
    uses: hoverkraft-tech/ci-github-publish/.github/workflows/release.yml@b56be562f38e0e3e712f09691a8fe930aae9db1b # 0.22.0
    permissions: {}
    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"]'

      # Whether to mark the release as a prerelease
      # See ../../actions/release/create/README.md for more information.
      prerelease: false

      # Working directory used to scope release automation in a monorepo.
      # If specified, the workflow looks for `.github/release-configs/{slug}.yml`, where `slug` is derived from the working directory basename.
      # If that file does not exist, a temporary release configuration is generated with `include-paths` for the working directory and current workflow file.
      working-directory: ""

      # Additional paths to include in the generated release configuration (JSON array).
      #
      # Default: `[]`
      include-paths: "[]"

Inputs

Workflow Dispatch 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.
prerelease Whether to mark the release as a prerelease false boolean false
See ../../actions/release/create/README.md for more information.
working-directory Working directory used to scope release automation in a monorepo. false string -
If specified, the workflow looks for .github/release-configs/{slug}.yml, where slug is derived from the working directory basename.
If that file does not exist, a temporary release configuration is generated with include-paths for the working directory and current workflow file.
include-paths Additional paths to include in the generated release configuration (JSON array). false string []

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.