Skip to content

peter-evans/create-issue-from-file

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date
Jul 25, 2020
Oct 2, 2020
Jul 7, 2019
Aug 22, 2020
May 3, 2020
Jan 24, 2020
Jul 7, 2019
Aug 4, 2020
May 11, 2020
Oct 1, 2020
Oct 1, 2020
May 6, 2020

Repository files navigation

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@v2
        with:
          title: An example issue
          content-filepath: ./example-content/output.md
          labels: report, automated issue

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 - Deprecated. See Create a project card for details.
  • project-column - Deprecated. See Create a project card for details.

Outputs

  • issue-number - The number of the created issue

Create a project card

To create a project card for the issue, pass the issue-number step output to create-or-update-project-card action.

      - name: Create Issue From File
        id: ciff
        uses: peter-evans/create-issue-from-file@v2
        with:
          title: An example issue
          content-filepath: ./example-content/output.md

      - name: Create or Update Project Card
        uses: peter-evans/create-or-update-project-card@v1
        with:
          project-name: My project
          column-name: My column
          issue-number: ${{ steps.ciff.outputs.issue-number }}

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