create-issue-from-file's Introduction

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 the file does not exist the action exits silently.

Usage

      - name: Create Issue From File
        uses: peter-evans/create-issue-from-file@v4
        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

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@v4
        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@v2
        with:
          project-name: My project
          column-name: My column
          issue-number: ${{ steps.ciff.outputs.issue-number }}