arno/trezor-firmware
1
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-11-17 05:03:07 +00:00
Code Issues Releases Wiki Activity

docs(python): use towncrier for generating CHANGELOG.md

Browse Source
This commit is contained in:
Martin Milata 2021-04-19 16:14:55 +02:00
parent ee1fda3f7f
commit b2b0ecf0f7
18 changed files with 59 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
python/.changelog.d/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
!.gitignore

1
python/.changelog.d/1167.changed Normal file
View File

@ -0,0 +1 @@
Support long PIN of up to 50 digits.

1
python/.changelog.d/1193.added Normal file
View File

@ -0,0 +1 @@
Support for temporary or permanent `safety-checks` setting

1
python/.changelog.d/1227.added Normal file
View File

@ -0,0 +1 @@
Enabled session management via `EndSession`

1
python/.changelog.d/1232.fixed Normal file
View File

@ -0,0 +1 @@
added missing dependency on `attrs`

1
python/.changelog.d/1257.fixed Normal file
View File

@ -0,0 +1 @@
fixed number imprecision in `build_tx.py` that could cause "invalid prevhash" errors

1
python/.changelog.d/1266.changed Normal file
View File

@ -0,0 +1 @@
`btc.sign_tx()` accepts keyword arguments for transaction metadata

1
python/.changelog.d/1363.added Normal file
View File

@ -0,0 +1 @@
Support for Output Descriptors export

1
python/.changelog.d/1496.added Normal file
View File

@ -0,0 +1 @@
PIN entry via letters

1
python/.changelog.d/1531.removed Normal file
View File

@ -0,0 +1 @@
dropped debug-only `trezorctl debug show-text` functionality

1
python/.changelog.d/379.changed Normal file
View File

@ -0,0 +1 @@
protobuf is aware of `required` fields and default values

1
python/.changelog.d/379.deprecated.1 Normal file
View File

@ -0,0 +1 @@
instantiating protobuf objects with positional arguments is deprecated

1
python/.changelog.d/379.deprecated.2 Normal file
View File

@ -0,0 +1 @@
values of required fields must be supplied at instantiation time. Omitting them is deprecated.

1
python/.changelog.d/379.deprecated.3 Normal file
View File

@ -0,0 +1 @@
`details` argument to `btc.sign_tx()` is deprecated. Use keyword arguments instead.

1
python/.changelog.d/810.removed Normal file
View File

@ -0,0 +1 @@
dropped Python 3.5 support

1
python/.towncrier.template.md Symbolic link
View File

@ -0,0 +1 @@
../tools/towncrier.template.md

40
python/CHANGELOG.md
View File

@ -5,39 +5,6 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.13.0] - Unreleased
[0.13.0]: https://github.com/trezor/trezor-firmware/compare/python/v0.12.2...master
### Added
- Enabled session management via `EndSession` [#1227]
- Support for temporary or permanent `safety-checks` setting
- Support for Output Descriptors export [#1363]
- PIN entry via letters [#1496]
### Changed
- protobuf is aware of `required` fields and default values
- `btc.sign_tx()` accepts keyword arguments for transaction metadata [#1266]
- Support long PIN of up to 50 digits. [#1167]
### Deprecated
- instantiating protobuf objects with positional arguments is deprecated
- values of required fields must be supplied at instantiation time. Omitting them is deprecated.
- `details` argument to `btc.sign_tx()` is deprecated. Use keyword arguments instead.
### Fixed
- added missing dependency on `attrs` [#1232]
- fixed number imprecision in `build_tx.py` that could cause "invalid prevhash" errors
### Removed
- dropped Python 3.5 support [#810]
- dropped debug-only `trezorctl debug show-text` functionality
## [0.12.2] - 2020-08-27
[0.12.2]: https://github.com/trezor/trezor-firmware/compare/python/v0.12.1...python/v0.12.2
@ -506,16 +473,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
[#349]: https://github.com/trezor/python-trezor/issues/349
[#351]: https://github.com/trezor/python-trezor/issues/351
[#352]: https://github.com/trezor/python-trezor/issues/352
[#810]: https://github.com/trezor/trezor-firmware/issues/810
[#948]: https://github.com/trezor/trezor-firmware/issues/948
[#1052]: https://github.com/trezor/trezor-firmware/issues/1052
[#1126]: https://github.com/trezor/trezor-firmware/issues/1126
[#1167]: https://github.com/trezor/trezor-firmware/issues/1167
[#1179]: https://github.com/trezor/trezor-firmware/issues/1179
[#1196]: https://github.com/trezor/trezor-firmware/issues/1196
[#1210]: https://github.com/trezor/trezor-firmware/issues/1210
[#1227]: https://github.com/trezor/trezor-firmware/issues/1227
[#1232]: https://github.com/trezor/trezor-firmware/issues/1232
[#1266]: https://github.com/trezor/trezor-firmware/issues/1266
[#1363]: https://github.com/trezor/trezor-firmware/pull/1363
[#1496]: https://github.com/trezor/trezor-firmware/pull/1496

43
python/towncrier.toml Normal file
View File

@ -0,0 +1,43 @@
[tool.towncrier]
directory = ".changelog.d"
filename = "CHANGELOG.md"
template = ".towncrier.template.md"
start_string = "The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)."
title_format = "\n## [{version}] - {project_date}"
issue_format = "[#{issue}]"
underlines = ["", ""]
[[tool.towncrier.type]]
directory = "added"
name = "Added"
showcontent = true
[[tool.towncrier.type]]
directory = "changed"
name = "Changed"
showcontent = true
[[tool.towncrier.type]]
directory = "deprecated"
name = "Deprecated"
showcontent = true
[[tool.towncrier.type]]
directory = "removed"
name = "Removed"
showcontent = true
[[tool.towncrier.type]]
directory = "fixed"
name = "Fixed"
showcontent = true
[[tool.towncrier.type]]
directory = "security"
name = "Security"
showcontent = true
[[tool.towncrier.type]]
directory = "incompatible"
name = "Incompatible changes"
showcontent = true