I can't trigger a workflow with `on: status` #25007

jasononeil · 2021-01-26T14:09:46Z

jasononeil
Jan 26, 2021

I am trying to create a workflow that is triggered when a new status is added to a commit sha, but can’t get it to trigger.

Repo: GitHub - jasononeil/github-action-status-test
Workflow in question: github-action-status-test/add-screenshot-gallery-as-comment.yml at 5c5d4dd10fa16b5c7c05b4e430ba8b67e3eeaeb7 · jasononeil/github-action-status-test · GitHub

Workflow yaml:

name: add screenshot gallery link as comment
on:
  - status
jobs:

add_screenshot_gallery_link_as_comment:

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v1
  - run: echo "Commit status is ${STATE}"
    env:
      STATE: ${{ github.event.status.state }

  - name: Find relevant PR
    uses: jwalton/gh-find-current-pr@v1
    id: findPr
    with:
      github-token: ${{ secrets.GITHUB_TOKEN }}

  - run: echo "Your PR is ${PR}"
    if: success() &amp;&amp; steps.findPr.outputs.pr
    env:
      PR: ${{ steps.findPr.outputs.pr }

  - name: Check if there is an existing comment
    if: success() &amp;&amp; steps.findPr.outputs.pr
    uses: peter-evans/find-comment@v1
    id: find_comment
    with:
      issue-number: ${{ steps.findPr.outputs.pr }}
      comment-author: 'github-actions[bot]'
      body-includes: '[View the Screenshot Gallery][1]'

  - name: Create a mew comment
    if: ${{ steps.find_comment.outputs.comment-id == 0 }}
    uses: peter-evans/create-or-update-comment@v1
    with:
      issue-number: ${{ steps.findPr.outputs.pr }}
      body: |
        :sparkles: [View the Screenshot Gallery][1] :sparkles:
        [1]: https://my-asset-host.com/screenshot-gallery/${{ github.sha }}/index.html
  - name: Update an existing comment
    if: ${{ steps.find_comment.outputs.comment-id != 0 }}
    uses: peter-evans/create-or-update-comment@v1
    with:
      comment-id: ${{ steps.find_comment.outputs.comment-id }}
      edit-mode: replace
      body: |
        :sparkles: [View the Screenshot Gallery][1] :sparkles:
        For commit ${{ github.sha }}
        [1]: https://my-asset-host.com/screenshot-gallery/${{ github.sha }}/index.html

So far I have tried:

Ensuring the workflow file is on the default branch (it is)
Ensuring the status events are for a sha on the default branch (They are, but I hope it will work for any sha though)
Attempting to find a single working example of someone using “on: status” in a workflow, but it’s hard to search for those term - I haven’t found an example yet.

Does anyone have a working example of a workflow triggered by “status” events?

Can anyone see what I’m doing wrong?

Thanks,
Jason

Answered by jasononeil

Jan 27, 2021

It turns out Github Actions aren’t statuses, they’re “checks”.

In my case the real repo I’m working on is using “statuses” but my example repo is using actions, so “checks”.

If I trigger a github status using curl then things magically work

     curl -request POST --url "https://api.github.com/repos/${ORG}/${REPO}/statuses/${SHA}" \
      --header "Authorization: token ${PERSONAL_API_TOKEN}" \
      --header 'content-type: application/json' \
      --data '{"state": "success", "description": "my status", "context": "some/unique/identifier", "target_url": "http://link-in-status/"}'

View full answer

jasononeil · 2021-01-26T14:10:25Z

jasononeil
Jan 26, 2021
Author

Here’s the actions tab showing no runs for the workflow have been triggered:

github.com

jasononeil/github-action-status-test

ns

Contribute to jasononeil/github-action-status-test development by creating an account on GitHub.

0 replies

jasononeil · 2021-01-27T14:38:53Z

jasononeil
Jan 27, 2021
Author

It turns out Github Actions aren’t statuses, they’re “checks”.

In my case the real repo I’m working on is using “statuses” but my example repo is using actions, so “checks”.

If I trigger a github status using curl then things magically work

     curl -request POST --url "https://api.github.com/repos/${ORG}/${REPO}/statuses/${SHA}" \
      --header "Authorization: token ${PERSONAL_API_TOKEN}" \
      --header 'content-type: application/json' \
      --data '{"state": "success", "description": "my status", "context": "some/unique/identifier", "target_url": "http://link-in-status/"}'

0 replies

jasononeil · 2021-01-27T14:39:29Z

jasononeil
Jan 27, 2021
Author

Final full working example of a github “on: status” workflow here:

github.com

jasononeil/github-action-status-test/blob/d01343af47962fcf42a1ca2afc5c43e1acb5e8eb/.github/workflows/add-screenshot-gallery-as-comment.yml

name: Add a comment with a link to the screenshot gallery Note about "status" events: - The workflow must be merged to master, a status on a commit in any branch will still run the workflow found on master - "status" events (like those from buildkite) are different to "check" events from Github actions. - You can check for a specific status using it's context. Find it using the API: curl \ --header "Accept: application/vnd.github.v3+json" \ --header 'Authorization: token ${PERSONAL_API_TOKEN}' \ https://api.github.com/repos/${ORG}/${REPO}/commits/${SHA}/status - You can trigger a "status" event manually for testing: curl -request POST --url "https://api.github.com/repos/${ORG}/${REPO}/statuses/${SHA}" \ --header "Authorization: token ${PERSONAL_API_TOKEN}" \ --header 'content-type: application/json' \ --data '{"state": "success", "description": "my status", "context": "some/unique/identifier", "target_url": "http://link-in-status/"}' on: status

jobs:

This file has been truncated. show original

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Community

I can't trigger a workflow with `on: status` #25007

{{title}}

Replies: 3 comments

{{title}}

{{title}}

{{title}}

Note about "status" events:

- The workflow must be merged to master, a status on a commit in any branch will still run the workflow found on master

- "status" events (like those from buildkite) are different to "check" events from Github actions.

- You can check for a specific status using it's context. Find it using the API:

curl \

--header "Accept: application/vnd.github.v3+json" \

--header 'Authorization: token ${PERSONAL_API_TOKEN}' \

https://api.github.com/repos/${ORG}/${REPO}/commits/${SHA}/status

- You can trigger a "status" event manually for testing:

curl -request POST --url "https://api.github.com/repos/${ORG}/${REPO}/statuses/${SHA}" \

--header "Authorization: token ${PERSONAL_API_TOKEN}" \

--header 'content-type: application/json' \

--data '{"state": "success", "description": "my status", "context": "some/unique/identifier", "target_url": "http://link-in-status/"}'

Select a reply

GitHub Community

I can't trigger a workflow with on: status #25007

jasononeil Jan 26, 2021

Replies: 3 comments

jasononeil Jan 26, 2021 Author

jasononeil/github-action-status-test

jasononeil Jan 27, 2021 Author

jasononeil Jan 27, 2021 Author

jasononeil/github-action-status-test/blob/d01343af47962fcf42a1ca2afc5c43e1acb5e8eb/.github/workflows/add-screenshot-gallery-as-comment.yml

Note about "status" events:

- The workflow must be merged to master, a status on a commit in any branch will still run the workflow found on master

- "status" events (like those from buildkite) are different to "check" events from Github actions.

- You can check for a specific status using it's context. Find it using the API:

curl \

--header "Accept: application/vnd.github.v3+json" \

--header 'Authorization: token ${PERSONAL_API_TOKEN}' \

https://api.github.com/repos/${ORG}/${REPO}/commits/${SHA}/status

- You can trigger a "status" event manually for testing:

curl -request POST --url "https://api.github.com/repos/${ORG}/${REPO}/statuses/${SHA}" \

--header "Authorization: token ${PERSONAL_API_TOKEN}" \

--header 'content-type: application/json' \

--data '{"state": "success", "description": "my status", "context": "some/unique/identifier", "target_url": "http://link-in-status/"}'

I can't trigger a workflow with `on: status` #25007

jasononeil
Jan 26, 2021

jasononeil
Jan 26, 2021
Author

jasononeil
Jan 27, 2021
Author

jasononeil
Jan 27, 2021
Author