GitHub Action: Find Jira Issue Keys In GitHub Event

This action will find the issue keys in the GitHub event and return them as a comma separated list

Action Usage

- uses: bitflight-devops/[email protected]
  with:
    # The github token used for authenticating to GitHub
    token: ''

    # A string to search for issues
    # Default:
    string: ''

    # A comma separated list of project names to include in the results by, i.e.
    # DEVOPS,PROJECT1
    # Default:
    projects: ''

    # A comma separated list of project names to exclude from the results by, i.e.
    # INTERNAL,PROJECT2
    projects_ignore: ''

    # When parsing commit messages, include merge and pull messages. This is disabled
    # by default, to exclude tickets that may be included or fixed in other branches
    # or pull requests.
    # Default: false
    include_merge_messages: ''

    # The Git Head Ref to which commit messages will be collected up to. If the
    # base_ref is included, and the github event is a pull_request or push, The
    # head_ref from the event will be used.
    head_ref: ''

    # The Git Base Ref to which commit messages will be collected up from.
    base_ref: ''

    # Should the commit messages be ignored when looking for issues
    # Default: false
    ignore_commits: ''

    # The Jira cloud base url including protocol i.e. 'https://company.atlassian.net'
    # or use environment variable JIRA_BASE_URL
    jira_base_url: ''

    # The Jira cloud user email address or use environment variable JIRA_USER_EMAIL
    jira_user_email: ''

    # The Jira cloud user api token or use environment variable JIRA_API_TOKEN
    jira_api_token: ''

    # If there is an error during transition, the action will error out.
    # Default: false
    fail_on_error: ''

GitHub Action Inputs

Input	Description	Default	Required
token	The github token used for authenticating to GitHub		true
string	A string to search for issues		false
projects	A comma separated list of project names to include in the results by, i.e. DEVOPS,PROJECT1		false
projects_ignore	A comma separated list of project names to exclude from the results by, i.e. INTERNAL,PROJECT2		false
include_merge_messages	When parsing commit messages, include merge and pull messages. This is disabled by default, to exclude tickets that may be included or fixed in other branches or pull requests.	false	false
head_ref	The Git Head Ref to which commit messages will be collected up to. If the base_ref is included, and the github event is a pull_request or push, The head_ref from the event will be used.		false
base_ref	The Git Base Ref to which commit messages will be collected up from.		false
ignore_commits	Should the commit messages be ignored when looking for issues		false
jira_base_url	The Jira cloud base url including protocol i.e. 'https://company.atlassian.net' or use environment variable JIRA_BASE_URL		false
jira_user_email	The Jira cloud user email address or use environment variable JIRA_USER_EMAIL		false
jira_api_token	The Jira cloud user api token or use environment variable JIRA_API_TOKEN		false
fail_on_error	If there is an error during transition, the action will error out.	false	false

GitHub Action Outputs

Output	Description	Default	Required
issues	A comma separated list of all Jira Issues found
title_issues	A comma separated list of Jira Issues found in the pull_request title
commit_issues	A comma separated list of Jira Issues found in the commits provided
ref_issues	A comma separated list of Jira Issues found in the git ref
string_issues	A comma separated list of Jira Issues found in the input string