Skip to content

Commit

Permalink
Drop an informative error message for towncrier failures
Browse files Browse the repository at this point in the history
  • Loading branch information
rmartin16 committed Nov 2, 2023
1 parent 81b95ef commit 511afd7
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .github/workflows/towncrier-run.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,21 @@ jobs:
run: python -m pip install ${{ inputs.tox-source }}

- name: Run towncrier check
id: tox
run: tox -e towncrier-check

- name: Towncrier Check Resolution Instructions
if: always() && steps.tox.outcome == 'failure'
run: |
echo '::error::*************************************************************************'
echo '::error::** Towncrier check failed for missing release note **'
echo '::error::*************************************************************************'
echo '::error:: '
echo '::error::A release note for the PR is missing from the `changes` directory.'
echo '::error:: '
echo '::error::Visit the documentation below to add one:'
echo '::error:: '
echo '::error:: https://toga.readthedocs.io/en/latest/how-to/contribute-code.html#add-change-information-for-release-notes'
echo '::error:: '
echo '::error::*************************************************************************'
exit 1

0 comments on commit 511afd7

Please sign in to comment.