From 6e34698de01c3975892d5f77a6e99917e90faf90 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Santiago=20Due=C3=B1as?= Date: Tue, 6 Apr 2021 11:04:45 +0200 Subject: [PATCH] Release 0.3.0 --- AUTHORS | 1 + NEWS | 24 +++++++++++++++++++ README.md | 10 ++++---- pyproject.toml | 8 +++---- release_tools/_version.py | 4 ++-- releases/0.3.0.md | 23 ++++++++++++++++++ ...-option-to-update-authors-file-content.yml | 12 ---------- ...inconsistent-stage-after-publish-fails.yml | 14 ----------- ...-before-saving-with-the-changelog-tool.yml | 14 ----------- 9 files changed, 59 insertions(+), 51 deletions(-) create mode 100644 releases/0.3.0.md delete mode 100644 releases/unreleased/add-option-to-update-authors-file-content.yml delete mode 100644 releases/unreleased/recover-from-the-inconsistent-stage-after-publish-fails.yml delete mode 100644 releases/unreleased/validate-content-before-saving-with-the-changelog-tool.yml diff --git a/AUTHORS b/AUTHORS index bb46f55..29dc66f 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,2 +1,3 @@ Santiago Dueñas +Venu Vardhan Reddy Tekula diff --git a/NEWS b/NEWS index 5b10632..a8aeb1b 100644 --- a/NEWS +++ b/NEWS @@ -1,5 +1,29 @@ # Releases +## Release Tools 0.3.0 - (2021-04-06) + +**New features:** + + * Validate content before saving with the changelog tool (#17)\ + When the editor opens with changelog, the user can make mistakes and + produce an invalid entry file. This would break the workflow and + produce error while doing semverup. This feature validates the format + of the yml file and gives info about the errors, if any. This gives an + option to edit the file incase it if has any mistakes, so you need not + create a new entry. + * Recover from the inconsistent state after publish fails (#18)\ + When publish fails, the command leaves the git repository in an + inconsistent state. The author needs to check the status of the + repository manually and then fix everything back to normal. This + feature checks for any possible errors; if it finds any, it informs + about them to the user and rollbacks the operations before it exists. + * Add option to update AUTHORS file content\ + The AUTHORS file has to updated periodically with the names of the + contributors. This has to be done manually. This feature adds the + option `--authors` which allows to update the AUTHORS file with the + names extracted from the unreleased changelog entries. + + ## GrimoireLab Release Tools 0.2.0 - (2020-03-09) **New features:** diff --git a/README.md b/README.md index bcc410e..a54cf1a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# GrimoireLab Release Tools [![Build Status](https://github.com/Bitergia/release-tools/workflows/tests/badge.svg)](https://github.com/Bitergia/release-tools/actions?query=workflow:tests+branch:master+event:push) [![codecov](https://codecov.io/gh/Bitergia/release-tools/branch/master/graph/badge.svg?token=T60WC78FPR)](https://codecov.io/gh/Bitergia/release-tools) +# Release Tools [![Build Status](https://github.com/Bitergia/release-tools/workflows/tests/badge.svg)](https://github.com/Bitergia/release-tools/actions?query=workflow:tests+branch:master+event:push) [![codecov](https://codecov.io/gh/Bitergia/release-tools/branch/master/graph/badge.svg?token=T60WC78FPR)](https://codecov.io/gh/Bitergia/release-tools) -Set of tools to generate GrimoireLab releases. +Set of tools to generate Python releases. -With this package, GrimoireLab maintainers are able to automate +With this package, Python maintainers are able to automate many of the boring and time consuming tasks related with packages and releases. @@ -52,8 +52,8 @@ $ poetry install ## Workflow Together with these tools, this package provides an **opinionated -way** to generate the release of a Python package. In GrimoireLab, -we think releases must be automated and provide useful information +way** to generate the release of a Python package. We think +releases must be automated and provide useful information to end users so they can understand better the changes between versions. Our tools fulfill those requirements. diff --git a/pyproject.toml b/pyproject.toml index 2b97636..c64404d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [tool.poetry] -name = "grimoirelab-release-tools" -version = "0.2.0" -description = "Set of tools to generate GrimoireLab releases." +name = "release-tools" +version = "0.3.0" +description = "Set of tools to generate Python releases." authors = [ "Santiago Dueñas " ] @@ -29,7 +29,7 @@ classifiers = [ keywords = [ "development", - "grimoirelab", + "build", ] [tool.poetry.scripts] diff --git a/release_tools/_version.py b/release_tools/_version.py index e8f71fd..68d1d77 100644 --- a/release_tools/_version.py +++ b/release_tools/_version.py @@ -1,2 +1,2 @@ -# File auto-generated by semverup on 2020-03-09 15:36:45.827715 -__version__ = "0.2.0" +# File auto-generated by semverup on 2021-04-06 08:54:29.753189 +__version__ = "0.3.0" diff --git a/releases/0.3.0.md b/releases/0.3.0.md new file mode 100644 index 0000000..9183b14 --- /dev/null +++ b/releases/0.3.0.md @@ -0,0 +1,23 @@ +## Release Tools 0.3.0 - (2021-04-06) + +**New features:** + + * Validate content before saving with the changelog tool (#17)\ + When the editor opens with changelog, the user can make mistakes and + produce an invalid entry file. This would break the workflow and + produce error while doing semverup. This feature validates the format + of the yml file and gives info about the errors, if any. This gives an + option to edit the file incase it if has any mistakes, so you need not + create a new entry. + * Recover from the inconsistent state after publish fails (#18)\ + When publish fails, the command leaves the git repository in an + inconsistent state. The author needs to check the status of the + repository manually and then fix everything back to normal. This + feature checks for any possible errors; if it finds any, it informs + about them to the user and rollbacks the operations before it exists. + * Add option to update AUTHORS file content\ + The AUTHORS file has to updated periodically with the names of the + contributors. This has to be done manually. This feature adds the + option `--authors` which allows to update the AUTHORS file with the + names extracted from the unreleased changelog entries. + diff --git a/releases/unreleased/add-option-to-update-authors-file-content.yml b/releases/unreleased/add-option-to-update-authors-file-content.yml deleted file mode 100644 index 537b18f..0000000 --- a/releases/unreleased/add-option-to-update-authors-file-content.yml +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Add option to update AUTHORS file content -category: added -author: Venu Vardhan Reddy Tekula -issue: null -notes: > - The AUTHORS file has to updated periodically with the - names of the contributors. This has to be done manually. - - This feature adds the option `--authors` which allows to - update the AUTHORS file with the names extracted from the - unreleased changelog entries. diff --git a/releases/unreleased/recover-from-the-inconsistent-stage-after-publish-fails.yml b/releases/unreleased/recover-from-the-inconsistent-stage-after-publish-fails.yml deleted file mode 100644 index 1b9df61..0000000 --- a/releases/unreleased/recover-from-the-inconsistent-stage-after-publish-fails.yml +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Recover from the inconsistent state after publish fails -category: added -author: Venu Vardhan Reddy Tekula -issue: 18 -notes: > - When publish fails, the command leaves the git repository - in an inconsistent state. The author needs to check the - status of the repository manually and then fix everything - back to normal. - - This feature checks for any possible errors; if it finds - any, it informs about them to the user and rollbacks the - operations before it exists. diff --git a/releases/unreleased/validate-content-before-saving-with-the-changelog-tool.yml b/releases/unreleased/validate-content-before-saving-with-the-changelog-tool.yml deleted file mode 100644 index 063eb8e..0000000 --- a/releases/unreleased/validate-content-before-saving-with-the-changelog-tool.yml +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Validate content before saving with the changelog tool -category: added -author: Venu Vardhan Reddy Tekula -issue: 17 -notes: > - When the editor opens with changelog, the user can make - mistakes and produce an invalid entry file. This would - break the workflow and produce error while doing semverup. - - This feature validates the format of the yml file and gives - info about the errors, if any. This gives an option to edit the - file incase it if has any mistakes, so you need not create a - new entry.