git-action-git-issue-creation

command module
v0.0.0-...-6bce550 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 28, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

README

Git Action Git Issue Creation

Git Action to create an Issue on a GitHub Repository. This action can be used to create an issue when a build fails in a Git Action workflow.

Usage

This action can be used after any other action. Below is simple example on using it:

1. Create a .github/workflows/git-issue-creation.yml

2. Add the following properties to git-issue-creation.yml file

on: push
name: Git Creation Demo
jobs:
  gitIssueCreation:
    name: Git Creation Demo
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - name: Git Creation Demo
        uses: senzing/git-action-git-issue-creation@1.0.0
        env:
          GITHUB_ISSUE_BODY: Demo'ing Git Issue Creation
          GITHUB_ISSUE_TITLE: Demo'ing Git Issue Creation
          GITHUB_REPO_NAME: git-action-github-issue-creation
          GITHUB_REPO_OWNER: Senzing
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          GITHUB_SHA: ${{ github.sha }}

Go here for a template yml with all environment variables.

Environment Variables

These are the environment variables that can be set to pass in additional information about the Git Action.

Variable Name Required Description
GITHUB_ISSUE_BODY Yes Body of the issue to be created.
GITHUB_ISSUE_TITLE Yes Title of the issue to be created.
GITHUB_OWNER Yes The owner of the repository which is normally seen in the URI as a prefix to the repository.
GITHUB_REPOSITORY Yes The name of the repository.
GITHUB_TOKEN Yes The GitHub access token used by Git Actions workflow. Can use the native token generated by Git Actions or create a custom secret.
GITHUB_COMMIT_SHA Yes The commit SHA associated to running the Git Action workflow.

Reference

License

Apache 2

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL