GitHub Status Action V2

Adds a status update to a commit. GitHub will always show the latest state of a context.

Important

Disclaimer This version was created because the original (V1) has been archived on May 1, 2024.

Usage

Inputs

• 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 be success, error, failure or pending
• context
  The context, is displayed as the name of the check
• description
  Short text explaining the status of the check
• owner
  The repository owner defaults to context github.repository_owner if omitted
• repository
  Repository, default to context github.repository if omitted
• sha
  SHA of commit to update status on, defaults to context github.sha
  *If using on: pull_request use github.event.pull_request.head.sha
• target_url
  Url to use for the details link. If omitted no link is shown.

Local Debugging with @github/local-action

To facilitate local debugging of your GitHub Action, this repository now includes support for @github/local-action. This utility allows you to run and debug your action code locally by simulating the GitHub Actions runtime environment.

Setup

1. Install the dependencies:

npm install

2. Run the local-action debugging command:

npx @github/local-action

This command bootstraps your environment and stubs out the GitHub Actions Toolkit APIs so that you can test your action locally.

For more detailed usage and advanced configuration, please refer to the local-action documentation.

Example

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}}

Permissions Settings for GitHub Actions

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.

Required Permissions

Refer to the GitHub documentation for a detailed list of available permissions.