-
Notifications
You must be signed in to change notification settings - Fork 6
/
NEWS
320 lines (268 loc) · 14.8 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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
# Releases
## Release Tools 0.6.0 - (2023-08-25)
**New features:**
* Notes command supports multiple authors in changelog entries (#49)\
The notes command supports exporting of multiple authors from the
changelog entries. You can add more than one author to the changelog
entry by defining them as ``` author: - John Smith
<[email protected]> - John Doe <[email protected]> ```
* Option `--bump-version` to increase version manually\
Include `--bump-version=[MAJOR, MINOR, PATCH]` argument to `sermverup`
command to increase the version number regardless the release notes
changes.
* Generate release notes for pre-releases\
The flag `--pre-release`, on the command `notes`, generates the notes
of a release candidate. Release notes include the changes in between
releases - regular and candidate releases - while the release
candidate notes only include the latest changes since the previous
release.
* Option to not cleanup on publishing\
Running `publish` with `--no-cleanup' option doesn't remove any
changelog entry from the repository.
* Option for release candidates versions\
Include a new argument to `semverup` to create pre-releases versions.
If the option `--pre-release` is included and the current version is
not a release candidate, it will create a new pre-release version
based on files or `--bump-version` argument. If the current version is
a release candidate, it will increase its pre-release part. For
example, in a repository with a bugfix changelog entry: - `0.2.0` +
`semverup --pre-release` = `0.2.1-rc.1` - `0.2.1-rc.1` + `semverup
--pre-release` = `0.2.1-rc.2` When the version is a pre-release, and
`--pre-release` is not specified, it will remove the pre-release part
and generate the final version. In a repository with changelog
entries: - `0.2.2-rc.1` + `semverup` = `0.2.2`
**Bug fixes:**
* Changelog valid filenames\
Creating filename from the title could create invalid paths. This
commits change the way the filename is created from the title
removing many of the special chars.
* Error removing changelog entries\
Changelog entries that are processed while doing a release that is not
a release candidate were raising a Git error.
* Ignore unreleased directory when publishing\
Publish command continues the execution if the directory
`releases/unreleased` doesn't exist.
* Option to include branch in `publish` command\
Include the `--remote-branch <branch>` option in `publish` to push to
a specific remote branch. By default it is `master`.
* Invalid release candidate version number when adding new changes\
`semverup` was not increasing the correct version number when the old
version was a release candidate and a new changelog was included.
Before it increased `0.0.5-rc.1` to `0.0.5-rc.2` when a minor
changelog entry was added while it should be `0.1.0-rc.1`.
**Breaking changes:**
* New categories definition (#55)\
Previously, only the `fixed` notes incremented the `patch` version,
and the other changes incremented MINOR. We updated this behavior.
From now on, `changed` and `removed` entries increment major version.
`added`, `deprecated`, `security`, `performance` and `other` increment
the minor version. `Fixed` and `dependency` increment the patch
version. If the version is 0.x.x new entries will upgrade minor
version at most.
**Dependencies updateds:**
* Update PyYAML version and drop Python 3.7\
PyYAML dependency updated to support Python 3.10 and drop Python 3.7
support
## Release Tools 0.6.0-rc.2 - (2023-08-25)
**New features:**
* Notes command supports multiple authors in changelog entries (#49)\
The notes command supports exporting of multiple authors from the
changelog entries. You can add more than one author to the changelog
entry by defining them as ``` author: - John Smith
<[email protected]> - John Doe <[email protected]> ```
* Option `--bump-version` to increase version manually\
Include `--bump-version=[MAJOR, MINOR, PATCH]` argument to `sermverup`
command to increase the version number regardless the release notes
changes.
* Generate release notes for pre-releases\
The flag `--pre-release`, on the command `notes`, generates the notes
of a release candidate. Release notes include the changes in between
releases - regular and candidate releases - while the release
candidate notes only include the latest changes since the previous
release.
* Option to not cleanup on publishing\
Running `publish` with `--no-cleanup' option doesn't remove any
changelog entry from the repository.
* Option for release candidates versions\
Include a new argument to `semverup` to create pre-releases versions.
If the option `--pre-release` is included and the current version is
not a release candidate, it will create a new pre-release version
based on files or `--bump-version` argument. If the current version is
a release candidate, it will increase its pre-release part. For
example, in a repository with a bugfix changelog entry: - `0.2.0` +
`semverup --pre-release` = `0.2.1-rc.1` - `0.2.1-rc.1` + `semverup
--pre-release` = `0.2.1-rc.2` When the version is a pre-release, and
`--pre-release` is not specified, it will remove the pre-release part
and generate the final version. In a repository with changelog
entries: - `0.2.2-rc.1` + `semverup` = `0.2.2`
**Bug fixes:**
* Changelog valid filenames\
Creating filename from the title could create invalid paths. This
commits change the way the filename is created from the title
removing many of the special chars.
* Error removing changelog entries\
Changelog entries that are processed while doing a release that is not
a release candidate were raising a Git error.
* Ignore unreleased directory when publishing\
Publish command continues the execution if the directory
`releases/unreleased` doesn't exist.
* Option to include branch in `publish` command\
Include the `--remote-branch <branch>` option in `publish` to push to
a specific remote branch. By default it is `master`.
* Invalid release candidate version number when adding new changes\
`semverup` was not increasing the correct version number when the old
version was a release candidate and a new changelog was included.
Before it increased `0.0.5-rc.1` to `0.0.5-rc.2` when a minor
changelog entry was added while it should be `0.1.0-rc.1`.
**Breaking changes:**
* New categories definition (#55)\
Previously, only the `fixed` notes incremented the `patch` version,
and the other changes incremented MINOR. We updated this behavior.
From now on, `changed` and `removed` entries increment major version.
`added`, `deprecated`, `security`, `performance` and `other` increment
the minor version. `Fixed` and `dependency` increment the patch
version. If the version is 0.x.x new entries will upgrade minor
version at most.
**Dependencies updateds:**
* Update PyYAML version and drop Python 3.7\
PyYAML dependency updated to support Python 3.10 and drop Python 3.7
support
## Release Tools 0.6.0-rc.1 - (2023-08-25)
**New features:**
* Notes command supports multiple authors in changelog entries (#49)\
The notes command supports exporting of multiple authors from the
changelog entries. You can add more than one author to the changelog
entry by defining them as ``` author: - John Smith
<[email protected]> - John Doe <[email protected]> ```
* Option `--bump-version` to increase version manually\
Include `--bump-version=[MAJOR, MINOR, PATCH]` argument to `sermverup`
command to increase the version number regardless the release notes
changes.
* Generate release notes for pre-releases\
The flag `--pre-release`, on the command `notes`, generates the notes
of a release candidate. Release notes include the changes in between
releases - regular and candidate releases - while the release
candidate notes only include the latest changes since the previous
release.
* Option to not cleanup on publishing\
Running `publish` with `--no-cleanup' option doesn't remove any
changelog entry from the repository.
* Option for release candidates versions\
Include a new argument to `semverup` to create pre-releases versions.
If the option `--pre-release` is included and the current version is
not a release candidate, it will create a new pre-release version
based on files or `--bump-version` argument. If the current version is
a release candidate, it will increase its pre-release part. For
example, in a repository with a bugfix changelog entry: - `0.2.0` +
`semverup --pre-release` = `0.2.1-rc.1` - `0.2.1-rc.1` + `semverup
--pre-release` = `0.2.1-rc.2` When the version is a pre-release, and
`--pre-release` is not specified, it will remove the pre-release part
and generate the final version. In a repository with changelog
entries: - `0.2.2-rc.1` + `semverup` = `0.2.2`
**Bug fixes:**
* Changelog valid filenames\
Creating filename from the title could create invalid paths. This
commits change the way the filename is created from the title
removing many of the special chars.
* Error removing changelog entries\
Changelog entries that are processed while doing a release that is not
a release candidate were raising a Git error.
* Ignore unreleased directory when publishing\
Publish command continues the execution if the directory
`releases/unreleased` doesn't exist.
* Option to include branch in `publish` command\
Include the `--remote-branch <branch>` option in `publish` to push to
a specific remote branch. By default it is `master`.
* Invalid release candidate version number when adding new changes\
`semverup` was not increasing the correct version number when the old
version was a release candidate and a new changelog was included.
Before it increased `0.0.5-rc.1` to `0.0.5-rc.2` when a minor
changelog entry was added while it should be `0.1.0-rc.1`.
**Breaking changes:**
* New categories definition (#55)\
Previously, only the `fixed` notes incremented the `patch` version,
and the other changes incremented MINOR. We updated this behavior.
From now on, `changed` and `removed` entries increment major version.
`added`, `deprecated`, `security`, `performance` and `other` increment
the minor version. `Fixed` and `dependency` increment the patch
version. If the version is 0.x.x new entries will upgrade minor
version at most.
**Dependencies updateds:**
* Update PyYAML version and drop Python 3.7\
PyYAML dependency updated to support Python 3.10 and drop Python 3.7
support
## 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`.