From c2a9722a27494ea342a09d503d2aa296535feef0 Mon Sep 17 00:00:00 2001 From: Andreas Maier Date: Thu, 10 Oct 2024 13:59:37 +0200 Subject: [PATCH] Release 1.0.0 Signed-off-by: Andreas Maier --- changes/100.feature.rst | 1 - changes/100.incompatible.rst | 2 -- changes/102.cleanup.rst | 1 - changes/111.feature.rst | 1 - changes/114.fix.rst | 1 - changes/80.feature.rst | 1 - changes/81.feature.rst | 1 - changes/82.feature.rst | 2 -- changes/83.feature.rst | 3 -- changes/84.feature.rst | 2 -- changes/85.feature.rst | 1 - changes/97.cleanup.rst | 2 -- changes/97.feature.1.rst | 3 -- changes/97.feature.2.rst | 2 -- changes/noissue.1.feature.rst | 1 - changes/noissue.1.fix.rst | 2 -- changes/noissue.2.fix.rst | 3 -- docs/changes.rst | 60 +++++++++++++++++++++++++++++++++++ 18 files changed, 60 insertions(+), 29 deletions(-) delete mode 100644 changes/100.feature.rst delete mode 100644 changes/100.incompatible.rst delete mode 100644 changes/102.cleanup.rst delete mode 100644 changes/111.feature.rst delete mode 100644 changes/114.fix.rst delete mode 100644 changes/80.feature.rst delete mode 100644 changes/81.feature.rst delete mode 100644 changes/82.feature.rst delete mode 100644 changes/83.feature.rst delete mode 100644 changes/84.feature.rst delete mode 100644 changes/85.feature.rst delete mode 100644 changes/97.cleanup.rst delete mode 100644 changes/97.feature.1.rst delete mode 100644 changes/97.feature.2.rst delete mode 100644 changes/noissue.1.feature.rst delete mode 100644 changes/noissue.1.fix.rst delete mode 100644 changes/noissue.2.fix.rst diff --git a/changes/100.feature.rst b/changes/100.feature.rst deleted file mode 100644 index 4ac8abb..0000000 --- a/changes/100.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Improved building of the Docker container to reduce its size. diff --git a/changes/100.incompatible.rst b/changes/100.incompatible.rst deleted file mode 100644 index 821f9a8..0000000 --- a/changes/100.incompatible.rst +++ /dev/null @@ -1,2 +0,0 @@ -Changed mage name of Docker container image from 'zhmcosforwarder' to -'zhmc_os_forwarder' to match the command name. diff --git a/changes/102.cleanup.rst b/changes/102.cleanup.rst deleted file mode 100644 index 05e0fdd..0000000 --- a/changes/102.cleanup.rst +++ /dev/null @@ -1 +0,0 @@ -Resolved most warnings in test and publish workflows. diff --git a/changes/111.feature.rst b/changes/111.feature.rst deleted file mode 100644 index 6c5238f..0000000 --- a/changes/111.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Increased zhmcclient to 1.18.0 to pick up fixes. diff --git a/changes/114.fix.rst b/changes/114.fix.rst deleted file mode 100644 index 2e4124e..0000000 --- a/changes/114.fix.rst +++ /dev/null @@ -1 +0,0 @@ -Fixed incorrect check for start branch in 'make start_tag'. diff --git a/changes/80.feature.rst b/changes/80.feature.rst deleted file mode 100644 index 7a51517..0000000 --- a/changes/80.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Migrated to pyproject.toml. diff --git a/changes/81.feature.rst b/changes/81.feature.rst deleted file mode 100644 index e00baa1..0000000 --- a/changes/81.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Migrated to using towncrier for managing change logs. diff --git a/changes/82.feature.rst b/changes/82.feature.rst deleted file mode 100644 index fbf61b7..0000000 --- a/changes/82.feature.rst +++ /dev/null @@ -1,2 +0,0 @@ -Added support for running the 'ruff' checker via "make ruff" and added that -to the test workflow. diff --git a/changes/83.feature.rst b/changes/83.feature.rst deleted file mode 100644 index d08634b..0000000 --- a/changes/83.feature.rst +++ /dev/null @@ -1,3 +0,0 @@ -Added support for running the 'bandit' checker with a new make target -'bandit', and added that to the GitHub Actions test workflow. -Adjusted the code in order to pass the bandit check. diff --git a/changes/84.feature.rst b/changes/84.feature.rst deleted file mode 100644 index 114a83a..0000000 --- a/changes/84.feature.rst +++ /dev/null @@ -1,2 +0,0 @@ -Support for and test of Python 3.13.0-rc.1. Needed to increase the minimum -versions of PyYAML to 6.0.2 and pyrsistent to 0.20.0. diff --git a/changes/85.feature.rst b/changes/85.feature.rst deleted file mode 100644 index 4a9cd8c..0000000 --- a/changes/85.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Test: Added tests for Python 3.13 (final version). diff --git a/changes/97.cleanup.rst b/changes/97.cleanup.rst deleted file mode 100644 index c4a0bc0..0000000 --- a/changes/97.cleanup.rst +++ /dev/null @@ -1,2 +0,0 @@ -Dev: Dropped the 'make upload' target, because the release to PyPI has -been migrated to using a publish workflow. diff --git a/changes/97.feature.1.rst b/changes/97.feature.1.rst deleted file mode 100644 index 399bdc5..0000000 --- a/changes/97.feature.1.rst +++ /dev/null @@ -1,3 +0,0 @@ -Dev: Encapsulated the releasing of a version to PyPI into new 'release_branch' -and 'release_publish' make targets. See the development documentation for -details. diff --git a/changes/97.feature.2.rst b/changes/97.feature.2.rst deleted file mode 100644 index a04f5dc..0000000 --- a/changes/97.feature.2.rst +++ /dev/null @@ -1,2 +0,0 @@ -Dev: Encapsulated the starting of a new version into new 'start_branch' and -'start_tag' make targets. See the development documentation for details. diff --git a/changes/noissue.1.feature.rst b/changes/noissue.1.feature.rst deleted file mode 100644 index 7e6d90f..0000000 --- a/changes/noissue.1.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Dev: Automatically update AUTHORS.md when building the distribution archives. diff --git a/changes/noissue.1.fix.rst b/changes/noissue.1.fix.rst deleted file mode 100644 index 14a06f6..0000000 --- a/changes/noissue.1.fix.rst +++ /dev/null @@ -1,2 +0,0 @@ -Dev: Fixed checks and missing removal of temp file in make targets for releasing -and starting a version. diff --git a/changes/noissue.2.fix.rst b/changes/noissue.2.fix.rst deleted file mode 100644 index 617edad..0000000 --- a/changes/noissue.2.fix.rst +++ /dev/null @@ -1,3 +0,0 @@ -Dev: In the make commands to create/update AUTHORS.md, added a reftag to the -'git shortlog' command to fix the issue that without a terminal (e.g. in GitHub -Actions), the command did not display any authors. diff --git a/docs/changes.rst b/docs/changes.rst index ad62635..739959b 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -23,6 +23,66 @@ Change log .. ============================================================================ .. towncrier start +Version 1.0.0 +^^^^^^^^^^^^^ + +Released: 2024-10-10 + +**Incompatible changes:** + +* Changed mage name of Docker container image from 'zhmcosforwarder' to + 'zhmc_os_forwarder' to match the command name. (`#100 `_) + +**Bug fixes:** + +* Dev: Fixed checks and missing removal of temp file in make targets for releasing + and starting a version. + +* Dev: In the make commands to create/update AUTHORS.md, added a reftag to the + 'git shortlog' command to fix the issue that without a terminal (e.g. in GitHub + Actions), the command did not display any authors. + +* Fixed incorrect check for start branch in 'make start_tag'. (`#114 `_) + +**Enhancements:** + +* Dev: Automatically update AUTHORS.md when building the distribution archives. + +* Migrated to pyproject.toml. (`#80 `_) + +* Migrated to using towncrier for managing change logs. (`#81 `_) + +* Added support for running the 'ruff' checker via "make ruff" and added that + to the test workflow. (`#82 `_) + +* Added support for running the 'bandit' checker with a new make target + 'bandit', and added that to the GitHub Actions test workflow. + Adjusted the code in order to pass the bandit check. (`#83 `_) + +* Support for and test of Python 3.13.0-rc.1. Needed to increase the minimum + versions of PyYAML to 6.0.2 and pyrsistent to 0.20.0. (`#84 `_) + +* Test: Added tests for Python 3.13 (final version). (`#85 `_) + +* Dev: Encapsulated the releasing of a version to PyPI into new 'release_branch' + and 'release_publish' make targets. See the development documentation for + details. (`#97 `_) + +* Dev: Encapsulated the starting of a new version into new 'start_branch' and + 'start_tag' make targets. See the development documentation for details. (`#97 `_) + +* Improved building of the Docker container to reduce its size. (`#100 `_) + +* Increased zhmcclient to 1.18.0 to pick up fixes. (`#111 `_) + +**Cleanup:** + +* Dev: Dropped the 'make upload' target, because the release to PyPI has + been migrated to using a publish workflow. (`#97 `_) + +* Resolved most warnings in test and publish workflows. (`#102 `_) + + Version 0.3.0 ^^^^^^^^^^^^^