Skip to content

Commit ac48be7

Browse files
committed
Autoformat changelog
1 parent c55dd7b commit ac48be7

File tree

2 files changed

+17
-28
lines changed

2 files changed

+17
-28
lines changed

CHANGELOG.md

Lines changed: 13 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
1-
Changelog
2-
=========
1+
# Changelog
32

4-
[1.4.0](../../releases/tag/v1.4.0) - Unreleased
5-
-----------------------------------------------
3+
## [1.4.0](../../releases/tag/v1.4.0) - Unreleased
64

75
### Internal changes
86

97
- Migrate from Autopep8 and Flake8 to Ruff
108

11-
[1.3.0](../../releases/tag/v1.3.0) - 2023-11-15
12-
-----------------------------------------------
9+
## [1.3.0](../../releases/tag/v1.3.0) - 2023-11-15
1310

1411
### Added
1512

1613
- Added `scrapy` extra
1714

18-
[1.2.0](../../releases/tag/v1.2.0) - 2023-10-23
19-
-----------------------------------------------
15+
## [1.2.0](../../releases/tag/v1.2.0) - 2023-10-23
2016

2117
### Added
2218

@@ -26,8 +22,7 @@ Changelog
2622

2723
- Fix lint error (E721) in unit tests (for instance checks use `isinstance()`)
2824

29-
[1.1.5](../../releases/tag/v1.1.5) - 2023-10-03
30-
-----------------------------------------------
25+
## [1.1.5](../../releases/tag/v1.1.5) - 2023-10-03
3126

3227
### Added
3328

@@ -38,8 +33,7 @@ Changelog
3833
- rewrote documentation publication to use Docusaurus
3934
- removed PR Toolkit workflow
4035

41-
[1.1.4](../../releases/tag/v1.1.4) - 2023-09-06
42-
-----------------------------------------------
36+
## [1.1.4](../../releases/tag/v1.1.4) - 2023-09-06
4337

4438
### Fixed
4539

@@ -51,16 +45,14 @@ Changelog
5145
- removed `pytest-randomly` Pytest plugin
5246
- unpinned `apify-client` and `apify-shared` to improve compatibility with their newer versions
5347

54-
[1.1.3](../../releases/tag/v1.1.3) - 2023-08-25
55-
-----------------------------------------------
48+
## [1.1.3](../../releases/tag/v1.1.3) - 2023-08-25
5649

5750
### Internal changes
5851

5952
- unified indentation in configuration files
6053
- update the `Actor.reboot` method to use the new reboot endpoint
6154

62-
[1.1.2](../../releases/tag/v1.1.2) - 2023-08-02
63-
-----------------------------------------------
55+
## [1.1.2](../../releases/tag/v1.1.2) - 2023-08-02
6456

6557
### Internal changes
6658

@@ -69,15 +61,13 @@ Changelog
6961
- started using environment variables with prefix `ACTOR_` instead of some with prefix `APIFY_`
7062
- pinned `apify-client` and `apify-shared` to prevent their implicit updates from breaking SDK
7163

72-
[1.1.1](../../releases/tag/v1.1.1) - 2023-05-23
73-
-----------------------------------------------
64+
## [1.1.1](../../releases/tag/v1.1.1) - 2023-05-23
7465

7566
### Fixed
7667

7768
- relaxed dependency requirements to improve compatibility with other libraries
7869

79-
[1.1.0](../../releases/tag/v1.1.0) - 2023-05-23
80-
-----------------------------------------------
70+
## [1.1.0](../../releases/tag/v1.1.0) - 2023-05-23
8171

8272
### Added
8373

@@ -94,8 +84,7 @@ Changelog
9484

9585
- switched from `setup.py` to `pyproject.toml` for specifying project setup
9686

97-
[1.0.0](../../releases/tag/v1.0.0) - 2023-03-13
98-
-----------------------------------------------
87+
## [1.0.0](../../releases/tag/v1.0.0) - 2023-03-13
9988

10089
### Internal changes
10190

@@ -106,8 +95,7 @@ Changelog
10695

10796
- fixed `RequestQueue` not loading requests from an existing queue properly
10897

109-
[0.2.0](../../releases/tag/v0.2.0) - 2023-03-06
110-
-----------------------------------------------
98+
## [0.2.0](../../releases/tag/v0.2.0) - 2023-03-06
11199

112100
### Breaking changes
113101

@@ -135,7 +123,6 @@ Changelog
135123
- added unit tests for the `EventManager` class
136124
- added more Flake8 plugins and fixed issues they reported
137125

138-
[0.1.0](../../releases/tag/v0.1.0) - 2023-02-09
139-
-----------------------------------------------
126+
## [0.1.0](../../releases/tag/v0.1.0) - 2023-02-09
140127

141128
Initial release of the package.

scripts/check_version_in_changelog.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,10 @@
1717

1818
with open(CHANGELOG_PATH, encoding='utf-8') as changelog_file:
1919
for line in changelog_file:
20-
# The heading for the changelog entry for the given version can start with either the version number, or the version number in a link
21-
if re.match(rf'\[?{current_package_version}([\] ]|$)', line):
20+
# Ensure that the heading in the changelog entry for the specified version includes a version number
21+
# enclosed in square brackets. This version number is formatted as a link to the corresponding
22+
# version tag on GitHub.
23+
if re.match(rf'## \[{current_package_version}\].*$', line):
2224
break
2325
else:
2426
raise RuntimeError(f'There is no entry in the changelog for the current package version ({current_package_version})')

0 commit comments

Comments
 (0)