Skip to content

Commit

Permalink
Release 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
sduenas committed Apr 6, 2021
1 parent 1bdcd74 commit 6e34698
Show file tree
Hide file tree
Showing 9 changed files with 59 additions and 51 deletions.
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
Santiago Dueñas <sduenas@bitergia.com>
Venu Vardhan Reddy Tekula <venu@bitergia.com>

24 changes: 24 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
@@ -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:**
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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.

Expand Down
8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 <sduenas@bitergia.com>"
]
Expand Down Expand Up @@ -29,7 +29,7 @@ classifiers = [

keywords = [
"development",
"grimoirelab",
"build",
]

[tool.poetry.scripts]
Expand Down
4 changes: 2 additions & 2 deletions release_tools/_version.py
Original file line number Diff line number Diff line change
@@ -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"
23 changes: 23 additions & 0 deletions releases/0.3.0.md
Original file line number Diff line number Diff line change
@@ -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.

12 changes: 0 additions & 12 deletions releases/unreleased/add-option-to-update-authors-file-content.yml

This file was deleted.

This file was deleted.

This file was deleted.

0 comments on commit 6e34698

Please sign in to comment.