GitHub Action
github-status-action-v2
v1.1.13
Latest version
Adds a status update to a commit. GitHub will always show the latest state of a context.
Warning
Disclaimer This version was created because the original (V1) has been archived on May 1, 2024.
authToken
(required)
Use secrets.GITHUB_TOKEN or your own token if you need to trigger other workflows that use "on: status"'state
(required)
The status of the check should only besuccess
,error
,failure
orpending
context
The context, is displayed as the name of the checkdescription
Short text explaining the status of the checkowner
The repository owner defaults to context github.repository_owner if omittedrepository
Repository, default to context github.repository if omittedsha
SHA of commit to update status on, defaults to context github.sha
If usingon: pull_request
usegithub.event.pull_request.head.sha
target_url
Url to use for the details link. If omitted no link is shown.
None.
name: "test"
on: # run on any PRs and main branch changes
pull_request:
push:
branches:
- main
permissions:
statuses: write
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run the action
uses: guibranco/github-status-action-v2@latest
with:
authToken: ${{secrets.GITHUB_TOKEN}}
context: 'Test run'
description: 'Passed'
state: 'success'
sha: ${{github.event.pull_request.head.sha || github.sha}}
With the introduction of the permissions
block in GitHub Actions, it is crucial to configure the necessary permissions for your workflows to function correctly. Below is a guide to help you set up the permissions securely and effectively.
Refer to the GitHub documentation for a detailed list of available permissions.