Refactor changelog

New changelog is at `docs/changelog.md` and uses the format defined at <https://keepachangelog.com/>. It only contins releases in the 3.x series. The old changelog at `docs/change_log/` remains in its old format as an archive and only contains older releases. The archive is removed from the site navigation and is only accessable from links in the new changelog. It is anticipated that only one major release (and its minor releases) will ever be in the new changelog at a time. Therefore, with the release of a future version 4.0, the 3.x changelog would be archived as well. Update the contributing guide to reflect the changes. Update the changelog validation workflow to use an action which understands the new format. Update deploy action to include release notes from changelog in a GitHub release.
Python-Markdown · Aug 11, 2023 · f50ac47 · f50ac47
1 parent 8ae73a0
commit f50ac47
Show file tree

Hide file tree

Showing 17 changed files with 831 additions and 811 deletions.
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
@@ -0,0 +1,27 @@
+name: changelog
+
+on:
+  pull_request:
+    branches:
+    - '**'
+    path:
+    # Only run if changes were made in markdown/
+    - 'markdown/**'
+
+# permissions:
+#   pull-requests: write
+
+jobs:
+  validate:
+
+    runs-on: ubuntu-latest
+    steps:
+    # - uses: actions/checkout@v2
+    - uses: dangoslen/changelog-enforcer@v3
+      with:
+        changeLogPath: 'docs/changelog.md'
+        missingUpdateErrorMessage: |
+          @${{ github.actor }}, thank you for your contribution. It appears that you have not added a comment to the
+          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.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -27,12 +27,25 @@ jobs:
         with:
           user: __token__
           password: ${{ secrets.PYPI_PASSWORD }}
+      - name: Get Changelog Entry
+        if: success()
+        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
-        if: success() && startsWith(github.ref, 'refs/tags/')
-        uses: fnkr/github-action-ghr@v1
-        env:
-          GHR_PATH: dist/
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        if: success()
+        uses: ncipollo/release-action@v1
+        with:
+          tag: ${{ steps.changelog_reader.outputs.version }}
+          name: Release ${{ steps.changelog_reader.outputs.version }}
+          body: ${{ steps.changelog_reader.outputs.changes }}
+          artifacts: dist/**
+          prerelease: ${{ steps.changelog_reader.outputs.status == 'prereleased' }}
+          draft: ${{ steps.changelog_reader.outputs.status == 'unreleased' }}
+          allowUpdates: true
 
   ghpages:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,21 @@
+name: docs
+
+on:
+  pull_request:
+    branches:
+    - '**'
+    # Only run when changes are made to the docs.
+    paths:
+    - 'docs/**'
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+      with:
+        use-quiet-mode: yes
+        use-verbose-mode: yes
+        check-modified-files-only: yes
+        base-branch: master
diff --git a/.github/workflows/process.yml b/.github/workflows/process.yml
diff --git a/.spell-dict b/.spell-dict
@@ -18,7 +18,10 @@ blockquotes
 boolean
 CamelCase
 Chodarev
+changelog
+changelogs
 CLI
+cPython
 CodeHilite
 codehilite
 Cogumbreiro
@@ -49,6 +52,7 @@ implementers
 InlineProcessor
 Jiryu
 JSON
+keepachangelog
 Kjell
 Krech
 kwargs

diff --git a/docs/change_log/index.md b/docs/change_log/index.md
@@ -3,116 +3,9 @@ title: Change Log
 Python-Markdown Change Log
 =========================
 
+!!! note
 
-*under development*: version 3.5 ([Notes](release-3.5.md))
-
-July 25, 2023: version 3.4.4 (a bug-fix release).
-
-* Add a special case for initial `'s` to smarty extension (#1305).
-* Unescape any backslash escaped inline raw HTML (#1358).
-* Unescape backslash escaped TOC token names (#1360).
-
-
-March 23, 2023: version 3.4.3 (a bug-fix release).
-
-* Restore console script (#1327).
-
-March 22, 2023: version 3.4.2 (a bug-fix release).
-
-* Improve standalone * and _ parsing (#1300).
-* Consider `<html>` HTML tag a block-level element (#1309).
-* Officially support Python 3.11.
-* Switch from `setup.py` to `pyproject.toml`.
-
-July 15, 2022: version 3.4.1 (a bug-fix release).
-
-* Fix an import issue with `importlib.util` (#1274).
-
-July 15, 2022: version 3.4 ([Notes](release-3.4.md)).
-
-May 5, 2022: version 3.3.7 (a bug-fix release).
-
-* Disallow square brackets in reference link ids (#1209).
-* Retain configured `pygments_style` after first code block (#1240).
-* Ensure fenced code attributes are properly escaped (#1247).
-
-Nov 17, 2021: version 3.3.6 (a bug-fix release).
-
-* Fix a dependency issue (#1195, #1196).
-
-Nov 16, 2021: version 3.3.5 (a bug-fix release).
-
-* Make the `slugify_unicode` function not remove diacritical marks (#1118).
-* Fix `[toc]` detection when used with `nl2br` extension (#1160).
-* Re-use compiled regex for block level checks (#1169).
-* Don't process shebangs in fenced code blocks when using CodeHilite (#1156).
-* Improve email address validation for Automatic Links (#1165).
-* Ensure `<summary>` tags are parsed correctly (#1079).
-* Support Python 3.10 (#1124).
-
-Feb 24, 2021: version 3.3.4 (a bug-fix release).
-
-* Properly parse unclosed tags in code spans (#1066).
-* Properly parse processing instructions in md_in_html (#1070).
-* Properly parse code spans in md_in_html (#1069).
-* Preserve text immediately before an admonition (#1092).
-* Simplified regex for HTML placeholders (#928) addressing (#932).
-* Ensure `permalinks` and `anchorlinks` are not restricted by `toc_depth` (#1107).
-* Fix corner cases with lists under admonitions (#1102).
-
-Oct 25, 2020: version 3.3.3 (a bug-fix release).
-
-* Unify all block-level tags (#1047).
-* Fix issue where some empty elements would have text rendered as `None` when using `md_in_html` (#1049).
-* Avoid catastrophic backtracking in `hr` regex (#1055).
-* Fix `hr` HTML handling (#1053).
-
-Oct 19, 2020: version 3.3.2 (a bug-fix release).
-
-* Properly parse inline HTML in md_in_html (#1040 & #1045).
-* Avoid crashing when md_in_html fails (#1040).
-
-Oct 12, 2020: version 3.3.1 (a bug-fix release).
-
-* Correctly parse raw `script` and `style` tags (#1036).
-* Ensure consistent class handling by `fenced_code` and `codehilite` (#1032).
-
-Oct 6, 2020: version 3.3 ([Notes](release-3.3.md)).
-
-May 8, 2020: version 3.2.2 (a bug-fix release).
-
-* Add `checklinks` tox environment to ensure all links in documentation are good.
-* Refactor extension API documentation (#729).
-* Load entry_points (for extensions) only once using `importlib.metadata`.
-* Do not double escape entities in TOC.
-* Correctly report if an extension raises a `TypeError` (#939).
-* Raise a `KeyError` when attempting to delete a nonexistent key from the
-  extension registry (#939).
-* Remove import of `packaging` (or `pkg_resources` fallback) entirely.
-* Remove `setuptools` as a run-time dependency (`install_required`).
-
-Feb 12, 2020: Released version 3.2.1 (a bug-fix release).
-
-* The `name` property in `toc_tokens` from the TOC extension now
-  escapes HTML special characters (`<`, `>`, and `&`).
-
-Feb 7, 2020: Released version 3.2 ([Notes](release-3.2.md)).
-
-May 20, 2019: Released version 3.1.1 (a bug-fix release).
-
-* Fixed import failure in `setup.py` when the source directory is not
-  on `sys.path` (#823).
-* Prefer public `packaging` module to pkg_resources' private copy of
-  it (#825).
-
-Mar 25, 2019: Released version 3.1 ([Notes](release-3.1.md)).
-
-Sept 28, 2018: Released version 3.0.1 (a bug-fix release).
-
-* Brought back the `version` and `version_info` variables (#709).
-* Added support for hexadecimal HTML entities (#712).
-
-Sept 21, 2018: Released version 3.0 ([Notes](release-3.0.md)).
+    This is an archive of the changelog prior to the release of version 3.0. See the [current changelog](../changelog.md) for up-to-date details.
 
 Jan 4, 2018: Released version 2.6.11 (a bug-fix release). Added a new
 `BACKLINK-TITLE` option to the footnote extension so that non-English