-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: use new template for CHANGELOG.md
The default template was changed in python-semantic-release. Now it includes the whole commit message and thus became too verbose. So this change introduces a custom template for CHANGELOG.md that resembles the old format, which is way shorter and cleaner.
- Loading branch information
Showing
2 changed files
with
66 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,72 @@ | ||
# Changelog | ||
# CHANGELOG | ||
|
||
## Unreleased | ||
|
||
* feat: update minimal required Python version: 3.7 -> 3.8 ([`211cdc0`](https://github.com/vdmit11/contextvars-registry/commit/211cdc0d6b1ece9cd90ef57fd28398b1d2526f06)) | ||
|
||
* feat: rename the project: contextvars-extras -> contextvars-registry ([`ea557fa`](https://github.com/vdmit11/contextvars-registry/commit/ea557fa55adb3f54a15b99266bc648ef033c015a)) | ||
|
||
<!--next-version-placeholder--> | ||
|
||
## v0.3.0 (2022-10-30) | ||
### Feature | ||
* Remove "under development" warnings, the code is stable enough ([`6e5518b`](https://github.com/vdmit11/contextvars-registry/commit/6e5518bd4be621f4f481297225970a05bb5abd7f)) | ||
|
||
* feat: remove "under development" warnings, the code is stable enough ([`6e5518b`](https://github.com/vdmit11/contextvars-registry/commit/6e5518bd4be621f4f481297225970a05bb5abd7f)) | ||
|
||
## v0.2.1 (2022-06-21) | ||
### Fix | ||
* ContextVarsRegistry.keys() triggers deferred_default ([`fc17c59`](https://github.com/vdmit11/contextvars-registry/commit/fc17c59c3518efa4190cef5a1ce7f02088df210a)) | ||
|
||
* fix: ContextVarsRegistry.keys() triggers deferred_default ([`fc17c59`](https://github.com/vdmit11/contextvars-registry/commit/fc17c59c3518efa4190cef5a1ce7f02088df210a)) | ||
|
||
## v0.2.0 (2022-06-21) | ||
### Feature | ||
* New method: `ContextVarExt.is_gettable` ([`77ff938`](https://github.com/vdmit11/contextvars-registry/commit/77ff9382bb72026905d86f0872e95316ee85a255)) | ||
* New flag: `ContextVarExt.default_is_set` ([`296fc9f`](https://github.com/vdmit11/contextvars-registry/commit/296fc9fefc00ce56020fd56556e98f4317987fb1)) | ||
|
||
* feat: new method: `ContextVarExt.is_gettable` ([`77ff938`](https://github.com/vdmit11/contextvars-registry/commit/77ff9382bb72026905d86f0872e95316ee85a255)) | ||
|
||
* feat: new flag: `ContextVarExt.default_is_set` ([`296fc9f`](https://github.com/vdmit11/contextvars-registry/commit/296fc9fefc00ce56020fd56556e98f4317987fb1)) | ||
|
||
## v0.1.0 (2022-02-14) | ||
### Feature | ||
* Allow setting properties using `with registry(var=value)` ([`0a02cf6`](https://github.com/vdmit11/contextvars-registry/commit/0a02cf6d0f263f743def3c8c66bf9e20302930c2)) | ||
|
||
* feat: allow setting properties using `with registry(var=value)` ([`0a02cf6`](https://github.com/vdmit11/contextvars-registry/commit/0a02cf6d0f263f743def3c8c66bf9e20302930c2)) | ||
|
||
## v0.0.12 (2022-02-12) | ||
### Fix | ||
* Missing type stub for ContextVarExt.deferred_default attribute ([`b088ea9`](https://github.com/vdmit11/contextvars-registry/commit/b088ea94fd9eaafdf802c8011e6224459d9b1958)) | ||
|
||
* fix: missing type stub for ContextVarExt.deferred_default attribute ([`b088ea9`](https://github.com/vdmit11/contextvars-registry/commit/b088ea94fd9eaafdf802c8011e6224459d9b1958)) | ||
|
||
## v0.0.11 (2022-02-12) | ||
### Fix | ||
* Wrong exception type thrown by ContextVarsRegistry.__delitem__ ([`876d342`](https://github.com/vdmit11/contextvars-registry/commit/876d3421519b2a8fca71eb1c0f9c596a3e816b49)) | ||
|
||
### Documentation | ||
* Change order of classes to put ContextVarExt to the top ([`a115a64`](https://github.com/vdmit11/contextvars-registry/commit/a115a64e67ccd554b7fdf2a204f3a740b83b5981)) | ||
* fix: wrong exception type thrown by ContextVarsRegistry.__delitem__ ([`876d342`](https://github.com/vdmit11/contextvars-registry/commit/876d3421519b2a8fca71eb1c0f9c596a3e816b49)) | ||
|
||
## v0.0.10 (2021-10-18) | ||
### Fix | ||
* Inconsistent defaults with existing ContextVar object ([`510e4e7`](https://github.com/vdmit11/contextvars-registry/commit/510e4e7674e1ce4cbcb0ff6408ce99348fa07318)) | ||
* Reset_to_default() doesn't when re-using existing ContextVar ([`2e57b3e`](https://github.com/vdmit11/contextvars-registry/commit/2e57b3e66a212631a79a88aa1484aaca40ab7843)) | ||
|
||
### Documentation | ||
* Delete useless CHANGELOG.md full of debugging leftovers ([`535565e`](https://github.com/vdmit11/contextvars-registry/commit/535565e5789204fbb85f609e74105a8152660fdd)) | ||
* fix: inconsistent defaults with existing ContextVar object ([`510e4e7`](https://github.com/vdmit11/contextvars-registry/commit/510e4e7674e1ce4cbcb0ff6408ce99348fa07318)) | ||
|
||
* fix: reset_to_default() doesn't when re-using existing ContextVar ([`2e57b3e`](https://github.com/vdmit11/contextvars-registry/commit/2e57b3e66a212631a79a88aa1484aaca40ab7843)) | ||
|
||
## v0.0.9 (2021-10-11) | ||
|
||
* fix: no real changes here, just testing semantic-release workflow ([`d2c716a`](https://github.com/vdmit11/contextvars-registry/commit/d2c716ae568f9e8b8067d2f456b574782d249191)) | ||
|
||
* fix: add commit_author and remove git user (just to see what happens) ([`343ba2d`](https://github.com/vdmit11/contextvars-registry/commit/343ba2db46da0f11f45d04af5bf1abe3fa417a80)) | ||
|
||
## v0.0.8 (2021-10-10) | ||
|
||
* fix: no real changes here, just testing semantic-release workflow ([`22750b4`](https://github.com/vdmit11/contextvars-registry/commit/22750b4fd4eaf827cffe26fca967d80c6d45bea7)) | ||
|
||
* fix: no real changes here, just testing semantic-release workflow ([`05a1d1b`](https://github.com/vdmit11/contextvars-registry/commit/05a1d1bc080067aaefe30ef126d32978992b950e)) | ||
|
||
## v0.0.7 (2021-10-10) | ||
|
||
* fix: add a quote character that I deleted by an accident ([`5b6c19d`](https://github.com/vdmit11/contextvars-registry/commit/5b6c19dbe4d2660b666e0187944a2e3f7f17e601)) | ||
|
||
* fix: no real changes here, just testing semantic-release commit parser ([`9faa542`](https://github.com/vdmit11/contextvars-registry/commit/9faa542b0d0c11212b33465b6eb27cc6af7c3f24)) | ||
|
||
## v0.0.6 (2021-10-10) | ||
|
||
* fix: no real changes here, just testing semantic-release commit parser ([`08208fb`](https://github.com/vdmit11/contextvars-registry/commit/08208fb66453bc0340f8132def450923599b8b99)) | ||
|
||
## v0.0.5 (2021-10-11) | ||
|
||
## v0.0.4 (2021-10-10) | ||
|
||
* fix: no changes here, just testing semantic-release commit parser ([`bdbb0c2`](https://github.com/vdmit11/contextvars-registry/commit/bdbb0c23d543d8c9ef3d668c770094734a711f61)) | ||
|
||
## v0.0.3 (2021-10-10) | ||
|
||
* fix: no changes here, just testing semantic-release commit parser ([`2ce33b0`](https://github.com/vdmit11/contextvars-registry/commit/2ce33b0ca60f7fae0adc7d1a2ce975540fd064b3)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# CHANGELOG | ||
{% if context.history.unreleased | length > 0 %} | ||
## Unreleased | ||
{% for type_, commits in context.history.unreleased | dictsort %}{% if type_ in ["feature", "fix"] %}{% for commit in commits %} | ||
* {{ commit.message.partition("\n")[0] }} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }})) | ||
{% endfor %}{% endif %}{% endfor %}{% endif %} | ||
{% for version, release in context.history.released.items() %} | ||
## {{ version.as_semver_tag() }} ({{ release.tagged_date.strftime("%Y-%m-%d") }}) | ||
{% for type_, commits in release["elements"] | dictsort %}{% if type_ in ["feature", "fix"] %}{% for commit in commits %} | ||
* {{ commit.message.partition("\n")[0] }} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }})) | ||
{% endfor %}{% endif %}{% endfor %}{% endfor %} |