A simple Github Action that allows us to update the status of the last commit in a pull request.

GitHub does not update the status of a commit when running workflow and therefore tools that rely on the context/status of a given commit are not compatible with it.

• token: Auth token used to add status commits

  • required
  • default: "${ github.token }"

• name: The Name of the status check to add to the commit

  • required
  • default: "GithubActions - ${GITHUB_WORKFLOW}"

• status: Commit or job status, based on this the action will set the correct status in the commit: Accepted values are: error, failure, pending, success and cancelled.

  If the passed status is pending it wil set status commit pending.

  If the passed status is failure or cancelled it will set status commit failure.

  If the passed status is success it will set status commit success.

  If the passed status is error it will set status commit error.

  • required
  • default: "pending"

• url: URL for the status check.

  • optional
  • default: ""

• description: Description for the status check.

  • optional
  • default: ""

• ignoreForks: If the pull request is from a fork the action won't add a status by default. This is because the action won't have a token with permissions to add the status to the commit. You can disable this, but then you'll have to provide a token with enough permissions to add status to the commits in the forks!

  • optional
  • default: "true"

• addHoldComment: If true the action will add a comment to the pull request. This is useful if you use prow, since prow won't detect the github actions, so you can use /hold and /hold cancel to avoid merging the PR before you want. Important: this will be disabled for forks if ignoreForks is set to true, this is because the default github token won't have permissions to add comments if your PR comes from a fork

  • optional
  • default: "false"

• pendingComment: This is the message to add to the pull request when the status is pending.

  • optional
  • default: "/hold"

• successComment: This is the message to add to the pull request when the status is success.

  • optional
  • default: "/hold cancel"

• failComment: This is the message to add to the pull request when the status is failure, error or cancelled.

  • optional
  • default: "/hold"

name: Test

on: [pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: ouzi-dev/[email protected]

name: Test

on: [pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: ouzi-dev/[email protected]
      with:
        status: "error"

name: Test

on: [pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: ouzi-dev/[email protected]
      with:
        addHoldComment: "true"
    - if: always()
      uses: ouzi-dev/[email protected]
      with:
        addHoldComment: "true"
        status: "${{ job.status }}"

### Action with custom hold comments

name: Test

on: [pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: ouzi-dev/[email protected]
      with:
        status: "pending"
        addHoldComment: "true"
        pendingComment: "action pending!"
        successComment: "action success!"
        failComment: "action failed!"

### Action no comments, set commit to "error" status and set url, description and specific name

name: Test

on: [pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: ouzi-dev/[email protected]
      with:
        status: "error"
        url: http://myurl.io/
        description: "this is my status check"
        name: "name of my status check"

name: Test

on: [pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: ouzi-dev/[email protected]
      with:
        token: "my_custom_token"
        ignoreForks: "false"

An example is Prow which uses the Github Status API to read the status of a given commit. Using this actions you can tell tide to not skip optional contexts and effectively wait for a GitHub Workflow to pass before merging.

tide:
  context_options:
    # Treat unknown contexts as required
    skip-unknown-contexts: false

Important: Before pushing your changes run make release to generate all the correct files and clean stuff, etc...