Skip to content
paperclip

GitHub Action

Comment artifact link on Pull Request description

v0.1.9 Latest version

Comment artifact link on Pull Request description

paperclip

Comment artifact link on Pull Request description

Update PR description with a link to download an artifact

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Comment artifact link on Pull Request description

              
  uses: PicoCentauri/comment-artifact@v0.1.9
Learn more about this action in PicoCentauri/comment-artifact

Choose a version

Add artifact link to Pull Requests

Comment Actions Artifacts from your Workflow Runs.

The action automatically edits Pull Requests' descriptions with link to download one or more artifacts. This action is heavily inspired by the ReadTheDocs action for previewing a documentation.

Example

Example of a description edited with link to download artifacts

Usage

- uses: PicoCentauri/comment-artifact@v1
  with:
    # Name of artifact defined using the
    # Default is 'artifact'
    name:

    # Description of link text that should appear in the updated comment of your
    # pull request. Default is 'Download artifact for this pull request'.
    description:

    # The id of the workflow run where the desired download artifact was uploaded from.
    # Optional. Default is ${{ github.run_id }}
    run-id:

To allow to update the comment update the permissions of your job to

permissions:
    pull-requests: write

Once you added this to your repository, next time anybody opens a Pull Request, the description will be edited to include the link to one or more artifacts.