yu-iskw / convert-to-draft-action

A custom GitHub Action to convert a pull request to draft if all workflows aren't passed

convert-to-draft-action

A custom GitHub Action to convert a pull request to draft if all workflows aren't passed

How to use

To use the convert-to-draft-action in your GitHub repository, follow these steps:

Create a Workflow File: Create a new workflow file in your repository under .github/workflows/check-workflows.yml with the following content:

name: Convert PR to Draft

on:
  pull_request:
    types:
      [
        opened,
        synchronize,
        reopened,
        ready_for_review,
        review_requested,
        auto_merge_enabled,
      ]

# If you want to cancel the previous workflow if a new one is triggered, use the following concurrency setting.
concurrency:
  # Group by pull request
  group: ${{ github.event.pull_request.number }}
  cancel-in-progress: true

jobs:
  convert_to_draft:
    runs-on: ubuntu-latest
    permissions:
      actions: read
      contents: read
      pull-requests: write
    # TIPS:
    # If you want to support a by-pass not to convert to draft, the subsequent code is commented out.
    # If the event is a pull request and the pull request doesn't have the "disable-convert-to-draft" label,
    # then the workflow will run.
    #if: ${{ github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'disable-convert-to-draft') }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Convert PR to Draft
        uses: yu-iskw/convert-to-draft-action@v0.3.0
        with:
          # Required
          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
          # Optional
          leave_comment: "1"
          # Optional
          comment_body: |
            The pull request has been converted to a draft because some workflows failed or are still running.
            Please get it ready to review after all workflows are passed.

Inputs

These inputs are defined in the action.yml file and are used to configure the behavior of the action when it runs. The convert-to-draft-action accepts the following inputs:

• GITHUB_TOKEN (required):
  • Description: The GitHub token used to authenticate the action.
  • Default: None
• leave_comment (optional):
  • Description: A flag to determine whether to leave a comment when the pull request is converted to a draft.
  • Default: "1"
• comment_body (optional):
  • Description: The body of the comment to leave when the pull request is converted to a draft.
  • Default: SEE action.yml