README.md

Create Issue From File

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 project variables are specified, a card will be added to a project. If the file does not exist the action exits silently.

Usage

    - name: Create Issue From File
      uses: peter-evans/create-issue-from-file@v2
      with:
        title: An example issue
        content-filepath: ./example-content/output.md
        labels: report, automated issue
        project: Example Project
        project-column: To do

Inputs

• token - GITHUB_TOKEN or a repo scoped PAT. Defaults to GITHUB_TOKEN.
• issue-number - The issue number of an existing issue to update
• title (required) - The title of the issue
• content-filepath (required) - The file path to the issue content
• labels - A comma separated list of labels
• assignees - A comma separated list of assignees (GitHub usernames)
• project - The name of the project for which a card should be created (Requires project-column-name)
• project-column - The name of the project column under which a card should be created

Outputs

• issue-number - The number of the created issue

Actions that pair with this action

• Link Checker - An action for link checking repository Markdown and HTML files

License

MIT License - see the LICENSE file for details