search

peter-evans / create-issue-from-file

A GitHub action to create an issue using content from a file
MIT License
146 stars 29 forks source link
github-action github-issues

readme

Create Issue From File

CI GitHub Marketplace

A GitHub action to create an issue using content from a file.

This is designed to be used in conjunction with other actions that output to a file. Especially if that output can be formatted as GitHub flavoured Markdown. This action will create an issue if a file exists at a specified path. The content of the issue will be taken from the file as-is. If the file does not exist the action exits silently.

Usage

      - name: Create Issue From File
        uses: peter-evans/create-issue-from-file@v5
        with:
          title: An example issue
          content-filepath: ./example-content/output.md
          labels: |
            report
            automated issue

Action inputs

Name Description Default
token GITHUB_TOKEN or a repo scoped PAT GITHUB_TOKEN
repository The target GitHub repository Current repository
issue-number The issue number of an existing issue to update
title (required) The title of the issue
content-filepath The file path to the issue content
labels A comma or newline-separated list of labels
assignees A comma or newline-separated list of assignees (GitHub usernames)

Outputs

License

MIT License - see the LICENSE file for details