From c7541754294c634cd807068ffaf37bd0279cbb52 Mon Sep 17 00:00:00 2001 From: github-actions Date: Sun, 31 Jul 2022 03:47:56 +0000 Subject: [PATCH] =?UTF-8?q?bump:=20release=202.1.0=20=E2=86=92=202.2.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 161 ++++++++++++++++++++++------------------ pyproject.toml | 2 +- src/package/__init__.py | 2 +- 3 files changed, 92 insertions(+), 73 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f4a4b332..e4dc33f9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,128 +1,147 @@ - +## v2.2.0 (2022-07-31) + +### Feat + +- generate SLSA level 3 provenance for release artifacts (#259) + +### Refactor + +- **ci**: use commitizen tool for pull request action (#263) + +### Fix + +- create empty pip.conf file inside a new virtual environment (#264) ## v2.1.0 (2022-07-12) -### Feature -* Use Bash as the shell to execute Makefile recipes ([#256](https://github.com/jenstroeger/python-package-template/issues/256)) ([`e214bee`](https://github.com/jenstroeger/python-package-template/commit/e214beea2210f0f90659b205cf4bf2bb65ab2db3)) -* Warn if generated builds are not reproducible ([#253](https://github.com/jenstroeger/python-package-template/issues/253)) ([`0d385f7`](https://github.com/jenstroeger/python-package-template/commit/0d385f7e4fc5ed5d2e7950ff963ca779d1f4fc4d)) -* Move private file .upgraded into .venv/ folder ([#248](https://github.com/jenstroeger/python-package-template/issues/248)) ([`2a24e24`](https://github.com/jenstroeger/python-package-template/commit/2a24e248a543f5e58020a7b522c73adbc3271d47)) ### Fix -* Default goal for make should be to build the entire package ([#257](https://github.com/jenstroeger/python-package-template/issues/257)) ([`b0c8511`](https://github.com/jenstroeger/python-package-template/commit/b0c8511b4a2572e7a814ef6aba3b1453c8d1faad)) -* Remove shebang comment from Makefile which isn’t actually runable ([#252](https://github.com/jenstroeger/python-package-template/issues/252)) ([`29e32ca`](https://github.com/jenstroeger/python-package-template/commit/29e32ca657207c8f9396405146743f075c55dd9f)) + +- default goal for make should be to build the entire package (#257) +- remove shebang comment from Makefile which isn’t actually runable (#252) + +### Feat + +- use Bash as the shell to execute Makefile recipes (#256) +- warn if generated builds are not reproducible (#253) +- move private file .upgraded into .venv/ folder (#248) ## v2.0.0 (2022-07-06) -### Feature -* Replace the Makefile’s quick-check goal with check-code ([#239](https://github.com/jenstroeger/python-package-template/issues/239)) ([`caba574`](https://github.com/jenstroeger/python-package-template/commit/caba574e55702c29aedca47614787f153f26a16f)) -* Add pytest-env and pytest-custom-exit-code plugin support ([#243](https://github.com/jenstroeger/python-package-template/issues/243)) ([`2e6e0ca`](https://github.com/jenstroeger/python-package-template/commit/2e6e0ca4f99212e9e03a5616d17ce202e156a056)) ### Fix -* Flit doesn’t support MANIFEST.in, fix sdist accordingly ([#244](https://github.com/jenstroeger/python-package-template/issues/244)) ([`20b9044`](https://github.com/jenstroeger/python-package-template/commit/20b9044fc233ae1262d96d433b0260bea4431eb1)) -### Breaking -* replace the Makefile’s quick-check goal with check-code ([#239](https://github.com/jenstroeger/python-package-template/issues/239)) ([`caba574`](https://github.com/jenstroeger/python-package-template/commit/caba574e55702c29aedca47614787f153f26a16f)) +- flit doesn’t support MANIFEST.in, fix sdist accordingly (#244) -### Documentation -* Remove symlinks to UPSTREAM files, use proper community files ([#245](https://github.com/jenstroeger/python-package-template/issues/245)) ([`e64554b`](https://github.com/jenstroeger/python-package-template/commit/e64554bc313f5860684f5b8949bdd0b86e472b8e)) +### Feat + +- replace the Makefile’s quick-check goal with check-code (#239) +- add pytest-env and pytest-custom-exit-code plugin support (#243) ## v1.6.1 (2022-06-26) + ### Fix -* Add explicit settings path to isort in pre-commit configuration ([#233](https://github.com/jenstroeger/python-package-template/issues/233)) ([`c75dc16`](https://github.com/jenstroeger/python-package-template/commit/c75dc1649c22e062d48af47ac8ac316971167780)) + +- add explicit settings path to isort in pre-commit configuration (#233) ## v1.6.0 (2022-06-24) -### Feature -* Consolidate sdist and wheel into a single build target ([#229](https://github.com/jenstroeger/python-package-template/issues/229)) ([`c7fa042`](https://github.com/jenstroeger/python-package-template/commit/c7fa04275cc04e35fbaa0af6f0a2bca9bc74e2ba)) ### Fix -* **ci:** Run all Actions except the Release job on the release commit ([#230](https://github.com/jenstroeger/python-package-template/issues/230)) ([`a86ad65`](https://github.com/jenstroeger/python-package-template/commit/a86ad65721683f7219b49900b2d1989bed3c0201)) + +- **ci**: run all Actions except the Release job on the release commit (#230) + +### Feat + +- consolidate sdist and wheel into a single build target (#229) ## v1.5.1 (2022-06-21) + ### Fix -* Bump min pytest version according to the "test" dependencies ([#220](https://github.com/jenstroeger/python-package-template/issues/220)) ([`f0352b7`](https://github.com/jenstroeger/python-package-template/commit/f0352b7659f010d60bbf74ba4c63910d169a276c)) -* Don’t pin Black to a particular Python version ([#217](https://github.com/jenstroeger/python-package-template/issues/217)) ([`b19ef03`](https://github.com/jenstroeger/python-package-template/commit/b19ef0337301c07f4a8ba4a688b20012b2fa9a52)) -### Documentation -* Remove mention of removed config files ([#218](https://github.com/jenstroeger/python-package-template/issues/218)) ([`9d09f5c`](https://github.com/jenstroeger/python-package-template/commit/9d09f5ce86e8ac8e49a881a90eadf337c7e09ced)) -* Add Hypothesis badge to the README ([#213](https://github.com/jenstroeger/python-package-template/issues/213)) ([`bb517ec`](https://github.com/jenstroeger/python-package-template/commit/bb517ec324040ed3620b097b9502ba20184dda78)) +- bump min pytest version according to the "test" dependencies (#220) +- don’t pin Black to a particular Python version (#217) + +### Refactor + +- **ci**: refactor and address security issues in workflows (#211) ## v1.5.0 (2022-06-20) -### Feature -* Move package specification, tool configs to pyproject.toml ([#208](https://github.com/jenstroeger/python-package-template/issues/208)) ([`be7ba06`](https://github.com/jenstroeger/python-package-template/commit/be7ba064192624558fbf97c2dea37a7189ccb3ad)) ### Fix -* **ci:** Release Action needs to use flit, too ([`db56423`](https://github.com/jenstroeger/python-package-template/commit/db56423ded764c39afbe6b00de730b53bf3d6c08)) -* **ci:** Use dedicated RELEASE_TOKEN for Release Action job ([#219](https://github.com/jenstroeger/python-package-template/issues/219)) ([`d0dcf33`](https://github.com/jenstroeger/python-package-template/commit/d0dcf33442ee868bd2e25e7092212aa31d2835f5)) -* **ci:** Enable Release Action for private, protected branches ([#209](https://github.com/jenstroeger/python-package-template/issues/209)) ([`5c8a47f`](https://github.com/jenstroeger/python-package-template/commit/5c8a47f13c26d727fea022a33b8c3baf87f7bbcd)) -* Add missing phony target to Makefile ([#200](https://github.com/jenstroeger/python-package-template/issues/200)) ([`6dc8a86`](https://github.com/jenstroeger/python-package-template/commit/6dc8a867aaea3ec943fa6c2db033e05dfc0ab368)) -### Documentation -* Add security policy documentation, elaborate on test policy ([#206](https://github.com/jenstroeger/python-package-template/issues/206)) ([`dc05694`](https://github.com/jenstroeger/python-package-template/commit/dc05694e59fd4a6fe166bb4425bd761b5f0016e6)) -* Elaborate on Python “package” and “application” ([#199](https://github.com/jenstroeger/python-package-template/issues/199)) ([`cc7e7e5`](https://github.com/jenstroeger/python-package-template/commit/cc7e7e516ec58714b5648149bd79ed925defc808)) -* Add missing TOC references, add OSSF link, fix typos ([#196](https://github.com/jenstroeger/python-package-template/issues/196)) ([`218eb08`](https://github.com/jenstroeger/python-package-template/commit/218eb08cece41796c25a01b0c9d34a7ff2a94e4d)) +- **ci**: Release Action needs to use flit, too +- **ci**: use dedicated RELEASE_TOKEN for Release Action job (#219) +- **ci**: enable Release Action for private, protected branches (#209) + +### Feat + +- move package specification, tool configs to pyproject.toml (#208) + +## v1.4.1 (2022-05-19) -## v1.4.1 (2022-05-20) ### Fix -* Add missing phony target to Makefile ([#200](https://github.com/jenstroeger/python-package-template/issues/200)) ([`6dc8a86`](https://github.com/jenstroeger/python-package-template/commit/6dc8a867aaea3ec943fa6c2db033e05dfc0ab368)) -### Documentation -* Elaborate on Python “package” and “application” ([#199](https://github.com/jenstroeger/python-package-template/issues/199)) ([`cc7e7e5`](https://github.com/jenstroeger/python-package-template/commit/cc7e7e516ec58714b5648149bd79ed925defc808)) -* Add missing TOC references, add OSSF link, fix typos ([#196](https://github.com/jenstroeger/python-package-template/issues/196)) ([`218eb08`](https://github.com/jenstroeger/python-package-template/commit/218eb08cece41796c25a01b0c9d34a7ff2a94e4d)) +- add missing phony target to Makefile (#200) + +## v1.4.0 (2022-05-17) + +### Feat -## v1.4.0 (2022-05-18) -### Feature -* Add scorecards analysis workflow ([#105](https://github.com/jenstroeger/python-package-template/issues/105)) ([`b72d1ae`](https://github.com/jenstroeger/python-package-template/commit/b72d1ae33e822682215257901992765c53894193)) +- add scorecards analysis workflow (#105) ### Fix -* On Windows, pip needs to run as a module ([#194](https://github.com/jenstroeger/python-package-template/issues/194)) ([`26d0919`](https://github.com/jenstroeger/python-package-template/commit/26d0919554285187f5f6353c647c3c3696b04c55)) + +- on Windows, pip needs to run as a module (#194) ## v1.3.2 (2022-05-06) + ### Fix -* Fix "make dist" failing on latest version of Ubuntu ([#190](https://github.com/jenstroeger/python-package-template/issues/190)) ([`ff652c6`](https://github.com/jenstroeger/python-package-template/commit/ff652c67d9aace8cdee19c1341447d075d627376)) + +- fix "make dist" failing on latest version of Ubuntu (#190) ## v1.3.1 (2022-05-05) + ### Fix -* Pass pylint configuration to pylint explicitly ([#188](https://github.com/jenstroeger/python-package-template/issues/188)) ([`49208e2`](https://github.com/jenstroeger/python-package-template/commit/49208e242451497d4575e6cdd2122884118df9ce)) -* Correctly depend on and ignore .upgraded Makefile helper file ([#187](https://github.com/jenstroeger/python-package-template/issues/187)) ([`dce14ef`](https://github.com/jenstroeger/python-package-template/commit/dce14ef58b47c6cbfb884b64a849f6aeab989f98)) -### Documentation -* Mention cost impact for different Action runners ([#189](https://github.com/jenstroeger/python-package-template/issues/189)) ([`e521f01`](https://github.com/jenstroeger/python-package-template/commit/e521f017a8fae4a0c050968921c2d2d8ab5bdd7e)) +- pass pylint configuration to pylint explicitly (#188) +- correctly depend on and ignore .upgraded Makefile helper file (#187) -## v1.3.0 (2022-04-11) -### Feature -* Add Makefile to enable the “Scripted Build” rule for SLSA Level 1 ([#74](https://github.com/jenstroeger/python-package-template/issues/74)) ([`05f226d`](https://github.com/jenstroeger/python-package-template/commit/05f226d53fb7b4ee0bb960754d77bc3d68e3305d)) +## v1.3.0 (2022-04-10) -### Documentation -* Improve comment to explain standalone-use of this package ([#119](https://github.com/jenstroeger/python-package-template/issues/119)) ([`391a95b`](https://github.com/jenstroeger/python-package-template/commit/391a95bdc1481dbf4170685f4a7b3de3021963d9)) +### Feat -## v1.2.0 (2022-01-20) -### Feature -* Enable CodeQL security analyzer ([#92](https://github.com/jenstroeger/python-package-template/issues/92)) ([`8095059`](https://github.com/jenstroeger/python-package-template/commit/8095059e55c989d5b1279403b7814fa24448b710)) -* Generate a command-line tool when installing this package ([#89](https://github.com/jenstroeger/python-package-template/issues/89)) ([`b172bcb`](https://github.com/jenstroeger/python-package-template/commit/b172bcb52600d7fd656b4a9d64b3dbbc6ef52c8e)) +- add Makefile to enable the “Scripted Build” rule for SLSA Level 1 (#74) + +## v1.2.0 (2022-01-19) ### Fix -* Change .yml to .yaml in documentation ([#101](https://github.com/jenstroeger/python-package-template/issues/101)) ([`e9a5fc0`](https://github.com/jenstroeger/python-package-template/commit/e9a5fc0eb52606865cd4238704e3403ba813092f)) -* Remove exclude option from mypy.ini ([#98](https://github.com/jenstroeger/python-package-template/issues/98)) ([`8b90b71`](https://github.com/jenstroeger/python-package-template/commit/8b90b71ae34d69ef6d848bd79d2c01dc89b46945)) -### Documentation -* Improve Dependabot comment in README ([#88](https://github.com/jenstroeger/python-package-template/issues/88)) ([`18e5a06`](https://github.com/jenstroeger/python-package-template/commit/18e5a0600c5d574277cc641111e1b1f3adb8100c)) +- change .yml to .yaml in documentation (#101) +- remove exclude option from mypy.ini (#98) + +### Feat + +- enable CodeQL security analyzer (#92) +- generate a command-line tool when installing this package (#89) ## v1.1.2 (2021-12-09) + ### Fix -* Add type marker to enable mypy’s use of this typed package ([#55](https://github.com/jenstroeger/python-package-template/issues/55)) ([`3595324`](https://github.com/jenstroeger/python-package-template/commit/359532435f2194772dfb31d82eb930f48e281515)) + +- add type marker to enable mypy’s use of this typed package (#55) ## v1.1.1 (2021-11-17) + ### Fix -* Git hook configuration didn’t match package paths anymore ([#39](https://github.com/jenstroeger/python-package-template/issues/39)) ([`b48d4b0`](https://github.com/jenstroeger/python-package-template/commit/b48d4b089c3ac63eae90e3a3d622bdd31fbde26e)) -### Documentation -* Update README.md to mention complete list of paths ([#33](https://github.com/jenstroeger/python-package-template/issues/33)) ([`e25fb95`](https://github.com/jenstroeger/python-package-template/commit/e25fb9561a9de6b7883cbf4b9f03ae25cb4dd290)) +- git hook configuration didn’t match package paths anymore (#39) ## v1.1.0 (2021-10-13) -### Feature -* Add dependency analysis for automatic version updates ([#3](https://github.com/jenstroeger/python-package-template/issues/3)) ([`12f8eec`](https://github.com/jenstroeger/python-package-template/commit/12f8eec6a51c9c9d4e76702a914e03cdead5e943)) + +### Feat + +- add dependency analysis for automatic version updates (#3) ## v1.0.0 (2021-09-29) -### Feature -* Initial version of the Python package template ([`695fcf2`](https://github.com/jenstroeger/python-package-template/commit/695fcf22e3604c872a5f0c7ac4b7c358739bcf75)) -### Breaking -* Initial version of the Python package template ([`695fcf2`](https://github.com/jenstroeger/python-package-template/commit/695fcf22e3604c872a5f0c7ac4b7c358739bcf75)) +### Feat + +- Initial version of the Python package template diff --git a/pyproject.toml b/pyproject.toml index d10fb9c7..8f411b97 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -88,7 +88,7 @@ update_changelog_on_bump = true version_files = [ "src/package/__init__.py:__version__", ] -version = "2.1.0" +version = "2.2.0" # https://github.com/pytest-dev/pytest-cov diff --git a/src/package/__init__.py b/src/package/__init__.py index 823fe46c..ca34eddf 100644 --- a/src/package/__init__.py +++ b/src/package/__init__.py @@ -6,4 +6,4 @@ # The version of this package. There's no comprehensive, official list of other # magic constants, so we stick with this one only for now. See also this conversation: # https://stackoverflow.com/questions/38344848/is-there-a-comprehensive-table-of-pythons-magic-constants -__version__ = "2.1.0" +__version__ = "2.2.0"