Skip to content

Creates or updates a PR label based on Success or failure of GitHub Action Steps

License

Notifications You must be signed in to change notification settings

Broadshield/github-action-pr-label-toggle

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Action: Pull Release Label Toggle

Creates or updates a PR label based on Success or Failure of GitHub Action Steps

Allows toggling of a label between two states, such as success or failure. This action should be used with: if: always() This action will check the actual status i.e. Unit Tests Success > Unit Tests Failing To access other repos pull requests, add an environment variable to this action of:

env:
  GITHUB_TOKEN: your token
- uses: Broadshield/[email protected]
  with:
    # This is a word like Passing, Success, Found, or 👍
    status_true_message: ""

    # This is a word like Error, Failure, Success, Not Found, or 👎
    status_false_message: ""

    # The prefix of the label to toggle like Unit Tests, DB Dump
    label_prefix: ""

    # This is a boolean status that can be passed in to override the detected status.
    # Default: false
    status: ""

    # The GitHub token to use for authentication.
    # Default: ${{github.token}}
    github_token: ""

    # The PR number to change the labels on. This is used when the action is triggered
    # by something other than a PR such as a PR comment, or a push, or anything else.
    pr_number: ""

    # If not provided, this is the same as github.repository i.e: The owner and
    # repository name. For example, Codertocat/Hello_World
    repository: ""

    # If true, do not update the label, just output the generated name
    # Default: false
    generate_only: ""

    # Switch the default `Success` to `✅` and `Failed` to `❌`
    # Default: false
    use_emoji: ""

    # the label prefix will be generated from the current action's job name:
    # underscores and hyphens are turned to spaces, first letter of each word
    # is capitalized.
    # Means the `label_prefix` can be empty.
    # `unit_tests` -> `Unit Tests`
    # `spellcheck` -> `Spellcheck`
    # Default: false
    use_job_name_as_prefix: ""
Input Description Default Required
status_true_message This is a word like Passing, Success, Found, or 👍 false
status_false_message This is a word like Error, Failure, Success, Not Found, or 👎 false
label_prefix The prefix of the label to toggle like Unit Tests, DB Dump false
status This is a boolean status that can be passed in to override the detected status. false
github_token The GitHub token to use for authentication. ${{github.token}} false
pr_number The PR number to change the labels on. This is used when the action is triggered by something other than a PR such as a PR comment, or a push, or anything else. false
repository If not provided, this is the same as github.repository i.e: The owner and repository name. For example, Codertocat/Hello_World false
generate_only If true, do not update the label, just output the generated name false
use_emoji Switch the default Success to and Failed to false
use_job_name_as_prefix the label prefix will be generated from the current action's job name:
underscores and hyphens are turned to spaces, first letter of each word
is capitalized.
Means the label_prefix can be empty.
unit_tests -> Unit Tests
spellcheck -> Spellcheck
false
**Output** **Description** **Default** **Required**
add_label_name The label name to add undefined undefined
remove_label_name The label name to remove undefined undefined
repository The repository to update undefined undefined
pr_number The pull request that is updated undefined undefined

About

Creates or updates a PR label based on Success or failure of GitHub Action Steps

Resources

License

Stars

Watchers

Forks

Packages

No packages published