Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update changelog validation #1388

Merged
merged 13 commits into from
Oct 31, 2023
Merged

Update changelog validation #1388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
89e6bc7
Update changelog validation
waylan Oct 6, 2023
841fc87
changelog edit
waylan Oct 6, 2023
241561e
fix syntax error
waylan Oct 6, 2023
a119442
force validation check
waylan Oct 6, 2023
db76fea
try again
waylan Oct 6, 2023
227f272
try again
waylan Oct 6, 2023
7ceec22
checkout first
waylan Oct 31, 2023
2b2ceb9
cleanup 3.3.5 changelog entry
waylan Oct 31, 2023
605a92c
cleanup 3.4.1 and 3.4.2 changelog entries
waylan Oct 31, 2023
c0de6cd
Uncomment rest of workflow
waylan Oct 31, 2023
695dc4f
Merge branch 'master' into logvalid
waylan Oct 31, 2023
ba7d4bd
revert edits that forced workflow to run for testing
waylan Oct 31, 2023
725e894
Always run changelog validation if an edit to changelog is made
waylan Oct 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions .github/workflows/changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -16,12 +17,20 @@ 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: |
@${{ 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.
- name: Validate Changelog
if: success()
id: changelog_reader
uses: mindsers/changelog-reader-action@v2
with:
validation_level: error
path: docs/changelog.md
1 change: 0 additions & 1 deletion .github/workflows/deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 4 additions & 12 deletions docs/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>` 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
Expand Down Expand Up @@ -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).
Expand All @@ -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 `<summary>` tags are parsed correctly (#1079).
* Support Python 3.10 (#1124).

## [3.3.4] -- 2021-02-24

Expand Down
Loading