Skip to content

need-fix-to-issue.md

Latest commit

 

History

History
153 lines (103 loc) · 5.34 KB

need-fix-to-issue.md

File metadata and controls

153 lines (103 loc) · 5.34 KB

GitHub Reusable Workflow: Need fix to Issue

Need fix to Issue

Release License Stars PRs Welcome

Overview

Reusable workflow to convert comments requiring fixes (todo, FIXME) to issues. Mainly using Todo to Issue Action, with some opinionated defaults.

Permissions

  • contents: read
  • issues: write

Usage

name: Need fix to Issue
on:
  push:
    branches:
      - main
permissions: {}
jobs:
  need-fix-to-issue:
    uses: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml@71b85947453f32b5d147ff3ab37351439a92d840 # 0.34.2
    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"]'

      # The SHA of the commit to get the diff for.
      manual-commit-ref: ""

      # By default, the commit entered above is compared to the one directly before it; to go back further, enter an earlier SHA here.
      manual-base-ref: ""

Tips:

It is recommended to add this trigger for this workflow:

workflow_dispatch:
  inputs:
    #checkov:skip=CKV_GHA_7: required
    manual-commit-ref:
      description: "The SHA of the commit to get the diff for."
      required: true
    manual-base-ref:
      description: "By default, the commit entered above is compared to the one directly before it; to go back further, enter an earlier SHA here."
      required: false

Inputs

Workflow Dispatch Inputs

Input Description Required Type Default
manual-commit-ref The SHA of the commit to get the diff for. true string -
manual-base-ref By default, the commit entered above is compared to the one directly before it; to go back further, enter an earlier SHA here. false string -

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.
manual-commit-ref The SHA of the commit to get the diff for. false string -
manual-base-ref By default, the commit entered above is compared to the one directly before it; to go back further, enter an earlier SHA here. 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.