forked from Bitergia/release-tools
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathNEWS
98 lines (76 loc) · 4.22 KB
/
NEWS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# Releases
## Release Tools 0.4.0 - (2022-06-02)
**Bug fixes:**
* Fix crash running the tools on git submodules (#44)\
Release tools didn't work when the project is under a git submodule.
* Notes command removes last author (#46)\
notes command was removing the last author from the `AUTHORS` file
when the file did not end with a blank line.
**Feature removals:**
* Drop Python 3.6 support\
Python 3.6 reached the end of life at the end of 2021. This means it
won't receive new updates or patches to fix security issues.
Therefore, this package will only work with Python >= 3.7 from now on.
## 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:**
* 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`.