From 91b005a159e434911409b3ecf4c50c86386a0d5d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Santiago=20Due=C3=B1as?= Date: Mon, 9 Mar 2020 16:45:54 +0100 Subject: [PATCH] Release 0.2.0 --- NEWS | 48 +++++++++++++++++++ pyproject.toml | 2 +- release_tools/_version.py | 4 +- releases/0.2.0.md | 46 ++++++++++++++++++ ...-unreleased-dir-exists-when-publishing.yml | 10 ---- .../push-release-only-with-only-push.yml | 18 ------- ...t-field-for-issue-in-changelog-entries.yml | 17 ------- ...news-file-with-the-latest-relase-notes.yml | 10 ---- .../update-version-in-pyproject-file.yml | 14 ------ 9 files changed, 97 insertions(+), 72 deletions(-) create mode 100644 releases/0.2.0.md delete mode 100644 releases/unreleased/check-if-unreleased-dir-exists-when-publishing.yml delete mode 100644 releases/unreleased/push-release-only-with-only-push.yml delete mode 100644 releases/unreleased/replace-pull-request-field-for-issue-in-changelog-entries.yml delete mode 100644 releases/unreleased/update-news-file-with-the-latest-relase-notes.yml delete mode 100644 releases/unreleased/update-version-in-pyproject-file.yml diff --git a/NEWS b/NEWS index 6ad76aa..5b10632 100644 --- a/NEWS +++ b/NEWS @@ -1,8 +1,56 @@ # Releases +## GrimoireLab Release Tools 0.2.0 - (2020-03-09) + +**New features:** + + * Push release only with `publish`\ + The command `publish` generates the commit and tag release but by + default it does not push them to a remote repository. The idea behind + this is to review the changes before pushing them. After the review, + to upload the new changes, it will necessary to call directly to `git + push` because `publish` will try to create the same release data + again. To fix this problem a the new flag `--only-push` is available. + When it is called together with `--push`, the command will ignore the + creation of the release pushing to the origin the latest changes. + * Update NEWS file with the latest relase notes\ + The command `notes` incorporates the new option `--news`. This flag + allows to add the contents of the notes generated for the relase to + the NEWS file. By default, NEWS file will not be updated during the + release. + * Automate version updates in pyproject file\ + Besides the file `_version.py`, there is another file that stores the + version number of the package. This file is `pyproject.toml` and is + used by `poetry` to generate Python packages and source code tarballs. + The command `semverup` will also update this version number when + called. This file will also be part of the release commit generated by + `publish` command. + +**Bug fixes:** + + * Check if unreleased dir exists when publishing (#5)\ + An exception was raised when `publish` command was called and + `unreleased` directory did not exist. Now, instead of raising an + exception, `publish` command fails and displays a message with the + error. + +**Feature changes:** + + * Replace pull request field for issue in changelog entries (#10)\ + The initial idea of the pull request field in a changelog entry was to + know which PR introduced the change. The problem is the reference is + unknown until the PR is generated, so developers will need to modify + the entry and the PR later to include the reference. Therefore, we + considered it is better to include a reference to an issue which is + more generic and can be known in advance. Take into account you will + need to update your unreleased changelog entries if you want to use + this new version of the tools. + + ## GrimoireLab Release Tools 0.1.0 - (2020-02-18) **New features:** * Initial release composed by the tools: `changelog`, `semverup`, `notes` and `publish`. + diff --git a/pyproject.toml b/pyproject.toml index 81c2b30..e0fe12e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "grimoirelab-release-tools" -version = "0.1.0" +version = "0.2.0" description = "Set of tools to generate GrimoireLab releases." authors = [ "Santiago Dueñas " diff --git a/release_tools/_version.py b/release_tools/_version.py index d6102a3..e8f71fd 100644 --- a/release_tools/_version.py +++ b/release_tools/_version.py @@ -1,2 +1,2 @@ -# File auto-generated by semverup on 2020-02-10 17:23:33.909238 -__version__ = "0.1.0" +# File auto-generated by semverup on 2020-03-09 15:36:45.827715 +__version__ = "0.2.0" diff --git a/releases/0.2.0.md b/releases/0.2.0.md new file mode 100644 index 0000000..e9d1cbd --- /dev/null +++ b/releases/0.2.0.md @@ -0,0 +1,46 @@ +## GrimoireLab Release Tools 0.2.0 - (2020-03-09) + +**New features:** + + * Push release only with `publish`\ + The command `publish` generates the commit and tag release but by + default it does not push them to a remote repository. The idea behind + this is to review the changes before pushing them. After the review, + to upload the new changes, it will necessary to call directly to `git + push` because `publish` will try to create the same release data + again. To fix this problem a the new flag `--only-push` is available. + When it is called together with `--push`, the command will ignore the + creation of the release pushing to the origin the latest changes. + * Update NEWS file with the latest relase notes\ + The command `notes` incorporates the new option `--news`. This flag + allows to add the contents of the notes generated for the relase to + the NEWS file. By default, NEWS file will not be updated during the + release. + * Automate version updates in pyproject file\ + Besides the file `_version.py`, there is another file that stores the + version number of the package. This file is `pyproject.toml` and is + used by `poetry` to generate Python packages and source code tarballs. + The command `semverup` will also update this version number when + called. This file will also be part of the release commit generated by + `publish` command. + +**Bug fixes:** + + * Check if unreleased dir exists when publishing (#5)\ + An exception was raised when `publish` command was called and + `unreleased` directory did not exist. Now, instead of raising an + exception, `publish` command fails and displays a message with the + error. + +**Feature changes:** + + * Replace pull request field for issue in changelog entries (#10)\ + The initial idea of the pull request field in a changelog entry was to + know which PR introduced the change. The problem is the reference is + unknown until the PR is generated, so developers will need to modify + the entry and the PR later to include the reference. Therefore, we + considered it is better to include a reference to an issue which is + more generic and can be known in advance. Take into account you will + need to update your unreleased changelog entries if you want to use + this new version of the tools. + diff --git a/releases/unreleased/check-if-unreleased-dir-exists-when-publishing.yml b/releases/unreleased/check-if-unreleased-dir-exists-when-publishing.yml deleted file mode 100644 index a61e254..0000000 --- a/releases/unreleased/check-if-unreleased-dir-exists-when-publishing.yml +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Check if unreleased dir exists when publishing -category: fixed -author: Santiago Dueñas -issue: 5 -notes: > - An exception was raised when `publish` command was called - and `unreleased` directory did not exist. Now, instead of - raising an exception, `publish` command fails and displays - a message with the error. diff --git a/releases/unreleased/push-release-only-with-only-push.yml b/releases/unreleased/push-release-only-with-only-push.yml deleted file mode 100644 index b6f8a15..0000000 --- a/releases/unreleased/push-release-only-with-only-push.yml +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Push release only with `publish` -category: added -author: Santiago Dueñas -issue: null -notes: > - The command `publish` generates the commit and tag - release but by default it does not push them to a - remote repository. The idea behind this is to review - the changes before pushing them. After the review, - to upload the new changes, it will necessary to call - directly to `git push` because `publish` will try to - create the same release data again. - - To fix this problem a the new flag `--only-push` is - available. When it is called together with `--push`, - the command will ignore the creation of the release - pushing to the origin the latest changes. diff --git a/releases/unreleased/replace-pull-request-field-for-issue-in-changelog-entries.yml b/releases/unreleased/replace-pull-request-field-for-issue-in-changelog-entries.yml deleted file mode 100644 index a48de88..0000000 --- a/releases/unreleased/replace-pull-request-field-for-issue-in-changelog-entries.yml +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Replace pull request field for issue in changelog entries -category: changed -author: Santiago Dueñas -issue: 10 -notes: > - The initial idea of the pull request field in a changelog - entry was to know which PR introduced the change. The problem - is the reference is unknown until the PR is generated, so - developers will need to modify the entry and the PR later - to include the reference. Therefore, we considered it is - better to include a reference to an issue which is more - generic and can be known in advance. - - Take into account you will need to update your unreleased - changelog entries if you want to use this new version of - the tools. diff --git a/releases/unreleased/update-news-file-with-the-latest-relase-notes.yml b/releases/unreleased/update-news-file-with-the-latest-relase-notes.yml deleted file mode 100644 index fc6c853..0000000 --- a/releases/unreleased/update-news-file-with-the-latest-relase-notes.yml +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Update NEWS file with the latest relase notes -category: added -author: Santiago Dueñas -issue: null -notes: > - The command `notes` incorporates the new option `--news`. - This flag allows to add the contents of the notes generated - for the relase to the NEWS file. By default, NEWS file - will not be updated during the release. diff --git a/releases/unreleased/update-version-in-pyproject-file.yml b/releases/unreleased/update-version-in-pyproject-file.yml deleted file mode 100644 index f53c91b..0000000 --- a/releases/unreleased/update-version-in-pyproject-file.yml +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Automate version updates in pyproject file -category: added -author: Santiago Dueñas -issue: null -notes: > - Besides the file `_version.py`, there is another file - that stores the version number of the package. This file is - `pyproject.toml` and is used by `poetry` to generate Python - packages and source code tarballs. The command `semverup` - will also update this version number when called. - - This file will also be part of the release commit generated - by `publish` command.