From 76af499a6771f0a120d5068119bd4af192ad8d79 Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Tue, 31 Oct 2023 14:46:01 -0400 Subject: [PATCH] Update changelog validation (#1388) Every edit to the changelog must be validated so that an invalid changelog doesn't block a release. --- .github/workflows/changelog.yml | 15 ++++++++++++--- .github/workflows/deploy.yml | 1 - docs/changelog.md | 16 ++++------------ 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml index b43d4d52..dec6ca2f 100644 --- a/.github/workflows/changelog.yml +++ b/.github/workflows/changelog.yml @@ -5,8 +5,9 @@ on: branches: - '**' path: - # Only run if changes were made in markdown/ + # Only run if changes were made in markdown/ or the changelog - 'markdown/**' + - 'docs/changelog.md' # permissions: # pull-requests: write @@ -16,8 +17,9 @@ jobs: runs-on: ubuntu-latest steps: - # - uses: actions/checkout@v2 - - uses: dangoslen/changelog-enforcer@v3 + - uses: actions/checkout@v2 + - name: Ensure Changelog Entry Made + uses: dangoslen/changelog-enforcer@v3 with: changeLogPath: 'docs/changelog.md' missingUpdateErrorMessage: | @@ -25,3 +27,10 @@ jobs: changelog describing the changes you have made. Doing so will help to ensure your contribution is accepted. Please see the [Contributing Guide](https://python-markdown.github.io/contributing/#changelog) for details. + - name: Validate Changelog + if: success() + id: changelog_reader + uses: mindsers/changelog-reader-action@v2 + with: + validation_level: error + path: docs/changelog.md diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 53409f7e..b10bf7e5 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -32,7 +32,6 @@ jobs: id: changelog_reader uses: mindsers/changelog-reader-action@v2 with: - validation_level: warn version: ${{ github.ref_name }} path: ./docs/changelog.md - name: Release to GitHub diff --git a/docs/changelog.md b/docs/changelog.md index ea36d16e..d7411eb6 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -58,21 +58,16 @@ links to the header, placing them after all other header content. ## [3.4.2] -- 2023-03-22 -### Added - -* Officially support Python 3.11. - ### Fixed - +* Officially support Python 3.11. * Improve standalone * and _ parsing (#1300). * Consider `` HTML tag a block-level element (#1309). - -### Infrastructure - * Switch from `setup.py` to `pyproject.toml`. ## [3.4.1] -- 2022-07-15 +### Fixed + * Fix an import issue with `importlib.util` (#1274). ## [3.4] -- 2022-07-15 @@ -194,10 +189,6 @@ valid parameter and will raise an error if provided. ## [3.3.5] -- 2021-11-16 -### Added - -* Support Python 3.10 (#1124). - ### Fixed * Make the `slugify_unicode` function not remove diacritical marks (#1118). @@ -206,6 +197,7 @@ valid parameter and will raise an error if provided. * Don't process shebangs in fenced code blocks when using CodeHilite (#1156). * Improve email address validation for Automatic Links (#1165). * Ensure `` tags are parsed correctly (#1079). +* Support Python 3.10 (#1124). ## [3.3.4] -- 2021-02-24