MRG: Merge pull request #4 from octue/enhancement/use-github-action-output

Use GitHub action output

Author: cortadocodes

.github/workflows/release.yml

@@ -26,7 +26,8 @@ jobs:
         uses: snok/install-poetry@v1
 
       - name: Get package version
-        run: echo "PACKAGE_VERSION=$(poetry version -s)" >> $GITHUB_ENV
+        id: get-package-version
+        run: echo "PACKAGE_VERSION=$(poetry version -s)" >> $GITHUB_OUTPUT
 
       - name: Install tox
         run: pip install tox
@@ -35,14 +36,13 @@ jobs:
         run: tox
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v3
         with:
-          file: coverage.xml
+          files: coverage.xml
           fail_ci_if_error: false
-          token: ${{ secrets.CODECOV_TOKEN }}
 
     outputs:
-      package_version: ${{ env.PACKAGE_VERSION }}
+      package_version: ${{ steps.get-package-version.outputs.PACKAGE_VERSION }}
 
   release:
     runs-on: ubuntu-latest

.github/workflows/update-pull-request.yml

@@ -20,12 +20,13 @@ jobs:
     - uses: actions/checkout@v3
 
     - uses: octue/generate-pull-request-description@main
+      id: pull-request-description
       with:
         pull_request_url: ${{ github.event.pull_request.url }}
         api_token: ${{ secrets.GITHUB_TOKEN }}
 
     - name: Update pull request body
       uses: riskledger/update-pr-description@v2
       with:
-        body: ${{ env.PULL_REQUEST_DESCRIPTION }}
+        body: ${{ steps.pull-request-description.outputs.pull_request_description }}
         token: ${{ secrets.GITHUB_TOKEN }}

Dockerfile

@@ -2,7 +2,7 @@ FROM python:3.10.7-slim
 
 RUN apt-get update && apt-get install -y --no-install-recommends git && rm -rf /var/lib/apt/lists/*
 
-RUN pip3 install git+https://github.com/octue/[email protected]0
+RUN pip3 install git+https://github.com/octue/[email protected]2
 
 COPY generate_pull_request_description/entrypoint.sh /entrypoint.sh
 

README.md

@@ -4,63 +4,39 @@
 [![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 
 # Pull request description generator
-A GitHub action and command-line tool that generates pull request descriptions from Conventional Commit messages on a
-branch. These descriptions can be used with other GitHub actions to automate release notes.
+A GitHub action that generates pull request descriptions from
+[Conventional Commit messages](https://www.conventionalcommits.org/en/v1.0.0/) on a branch. These descriptions can be
+used with other GitHub actions to automate release notes.
 
-**Features**
+**Features summary**
 - Automatic breaking change highlighting and upgrade instructions
 - Automatic categorisation of all commit messages in the pull request branch
 - Choosing which part of the description to generate, enabling descriptions containing a generated section alongside
-  static/developer-written sections
+  static/user-written sections
 - Easy skipping of description updating when you're ready to fine-tune and edit the description
 
-## GitHub action
-The generator can easily be used as a step in a GitHub workflow alongside the
-[`riskledger/update-pr-description`](https://github.com/riskledger/update-pr-description) action:
+## Usage
+Add the action to pull request workflows alongside the
+[`riskledger/update-pr-description`](https://github.com/riskledger/update-pr-description) action to dynamically update
+the description each time you push:
 
 ```yaml
 steps:
 - uses: actions/checkout@v3
 
-- uses: octue/[email protected]
+- uses: octue/[email protected]
+  id: pr-description
   with:
     pull_request_url: ${{ github.event.pull_request.url }}
     api_token: ${{ secrets.GITHUB_TOKEN }}
 
 - name: Update pull request body
   uses: riskledger/update-pr-description@v2
   with:
-    body: ${{ env.PULL_REQUEST_DESCRIPTION }}
+    body: ${{ steps.pr-description.outputs.pull_request_description }}
     token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-The generated description is available from the environment variable `PULL_REQUEST_DESCRIPTION` instead of as an output
-of the action (`::set-output...` only works with single-line outputs). It's accessible from
-`${{ env.PULL_REQUEST_DESCRIPTION }}` at any point in the workflow job it was used in.
-
-## CLI
-```shell
-usage: generate-pull-request-description [-h] [--pull-request-url PULL_REQUEST_URL] [--api-token API_TOKEN] [--header HEADER] [--list-item-symbol LIST_ITEM_SYMBOL] [--no-link-to-pull-request] {LAST_RELEASE,PULL_REQUEST_START}
-
-positional arguments:
-  {LAST_RELEASE,PULL_REQUEST_START}
-                        The point in the git history to stop compiling commits into the pull request description.
-
-options:
-  -h, --help            show this help message and exit
-  --pull-request-url PULL_REQUEST_URL
-                        Provide the API URL of a pull request (e.g. https://api.github.com/repos/octue/conventional-commits/pulls/1) if you want to update a pull request's description with the generated release notes. It must be
-                        provided alongside --api-token if the repository is private.
-  --api-token API_TOKEN
-                        A valid GitHub API token for the repository the pull request belongs to. There is no need to provide this if the repository is public.
-  --header HEADER       The header (including MarkDown styling) to put the release notes under. Default is '# Contents'
-  --list-item-symbol LIST_ITEM_SYMBOL
-                        The MarkDown list item symbol to use for listing commit messages in the release notes. Default is '- '
-  --no-link-to-pull-request
-                        If provided, don't add a link to the given pull request in the release notes.
-
-```
-
 ## Features
 
 ### Breaking change highlighting

action.yaml

@@ -1,6 +1,9 @@
-name: 'Generate release notes'
-description: "Generate release notes from the Conventional Commits on a pull request branch. You can use this action in conjunction with `riskledger/update-pr-description@v2` to automatically update a pull request's description as commits are pushed."
+name: 'Generate pull request description'
+description: "Dynamically generate the pull request description for a branch from its commit messages."
 author: 'cortadocodes'
+branding:
+  icon: git-pull-request
+  color: green
 inputs:
   pull_request_url:
     description: 'The GitHub API URL for the pull request to generate the release notes from. This can be obtained from the GitHub actions environment.'
@@ -16,9 +19,13 @@ inputs:
     description: 'The MarkDown list item symbol to use for listing commit messages in the release notes.'
     required: false
     default: '-'
+outputs:
+  pull_request_description:
+    description: 'The generated pull request description.'
+
 runs:
    using: 'docker'
-   image: 'docker://octue/generate-pull-request-description:1.0.0.beta-0'
+   image: 'docker://octue/generate-pull-request-description:1.0.0.beta-2'
    args:
      - ${{ inputs.pull_request_url }}
      - ${{ inputs.api_token }}

generate_pull_request_description/entrypoint.sh

@@ -1,6 +1,6 @@
 #!/bin/sh -l
 cd $GITHUB_WORKSPACE
 
-echo 'PULL_REQUEST_DESCRIPTION<<EOF' >> $GITHUB_ENV
-echo "$(generate-pull-request-description PULL_REQUEST_START --pull-request-url="$1" --api-token="$2" --header="$3" --list-item-symbol="$4")" >> $GITHUB_ENV
-echo EOF >> $GITHUB_ENV
+echo 'pull_request_description<<EOF' >> $GITHUB_OUTPUT
+echo "$(generate-pull-request-description PULL_REQUEST_START --pull-request-url="$1" --api-token="$2" --header="$3" --list-item-symbol="$4")" >> $GITHUB_OUTPUT
+echo EOF >> $GITHUB_OUTPUT

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "generate-pull-request-description"
-version = "1.0.0.beta-1"
+version = "1.0.0.beta-2"
 description = "A GitHub action that summarises the commits in a pull request for its description."
 authors = ["Marcus Lugg <[email protected]>"]
 readme = "README.md"