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

docs(core+legacy): use towncrier for generating CHANGELOG.md

Browse Source 
core/embed/boardloader/CHANGELOG.md
core/embed/bootloader/CHANGELOG.md
core/embed/bootloader_ci/CHANGELOG.md
legacy/intermediate_fw/CHANGELOG.md
This commit is contained in:
Martin Milata 2021-06-22 00:43:04 +02:00 committed by matejcik
parent d35071d732
commit 412d06fdfe
24 changed files with 41 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Makefile
View File

@ -41,9 +41,13 @@ pystyle: ## apply code style on application sources and tests
changelog_check: ## check changelog format changelog_check: ## check changelog format
./tools/generate-changelog.py --check core ./tools/generate-changelog.py --check core
./tools/generate-changelog.py --check python ./tools/generate-changelog.py --check core/embed/boardloader
./tools/generate-changelog.py --check legacy/firmware ./tools/generate-changelog.py --check core/embed/bootloader
./tools/generate-changelog.py --check core/embed/bootloader_ci
./tools/generate-changelog.py --check legacy/bootloader ./tools/generate-changelog.py --check legacy/bootloader
./tools/generate-changelog.py --check legacy/firmware
./tools/generate-changelog.py --check legacy/intermediate_fw
./tools/generate-changelog.py --check python
yaml_check: ## check yaml formatting yaml_check: ## check yaml formatting
yamllint . yamllint .

2
ci/check_changelog.sh
View File

@ -2,7 +2,7 @@
base_branch=master base_branch=master
fail=0 fail=0
subdirs="core python legacy/firmware legacy/bootloader" subdirs="core core/embed/boardloader core/embed/bootloader core/embed/bootloader_ci legacy/bootloader legacy/firmware legacy/intermediate_fw python"
changed_files=$(mktemp) changed_files=$(mktemp)
trap 'rm -- $changed_files' EXIT trap 'rm -- $changed_files' EXIT

1
core/embed/boardloader/.changelog.d/.gitignore vendored Normal file
View File

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

1
core/embed/boardloader/.towncrier.template.md Symbolic link
View File

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

12
core/embed/boardloader/CHANGELOG.md
View File

@ -4,15 +4,3 @@ 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/). The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [Unreleased]
### Added
### Deprecated
### Removed
### Fixed
### Security

1
core/embed/boardloader/CHANGELOG.unreleased Symbolic link
View File

@ -0,0 +1 @@
../../../tools/generate-changelog-unreleased.sh

1
core/embed/boardloader/towncrier.toml Symbolic link
View File

@ -0,0 +1 @@
../../../tools/towncrier.toml

1
core/embed/bootloader/.changelog.d/.gitignore vendored Normal file
View File

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

1
core/embed/bootloader/.towncrier.template.md Symbolic link
View File

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

20
core/embed/bootloader/CHANGELOG.md
View File

@ -4,33 +4,19 @@ 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/). The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [Unreleased]
### Added ## 2.0.3 [March 2019]
### Deprecated
### Removed
### Fixed
### Security
------------
## 2.0.3 [Mar 2019]
### Security ### Security
- Enable MPU - Enable MPU
- Introduce delays to USB stack - Introduce delays to USB stack
## 2.0.2 [Dec 2018] ## 2.0.2 [December 2018]
### Added ### Added
- Support for a new display driver - Support for a new display driver
## 2.0.1 [Feb 2018] ## 2.0.1 [February 2018]
### Added ### Added
- First public release - First public release

1
core/embed/bootloader/CHANGELOG.unreleased Symbolic link
View File

@ -0,0 +1 @@
../../../tools/generate-changelog-unreleased.sh

1
core/embed/bootloader/towncrier.toml Symbolic link
View File

@ -0,0 +1 @@
../../../tools/towncrier.toml

1
core/embed/bootloader_ci/.changelog.d/.gitignore vendored Normal file
View File

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

1
core/embed/bootloader_ci/.towncrier.template.md Symbolic link
View File

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

15
core/embed/bootloader_ci/CHANGELOG.md
View File

@ -4,19 +4,8 @@ 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/). The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [Unreleased]
### Added ## 1.0.1 [January 2021]
### Deprecated
### Removed
### Fixed
### Security
## 1.0.1 [Jan 2021]
### Added ### Added
- Decouple files from original bootloader as it will be reworked and symlink - Decouple files from original bootloader as it will be reworked and symlink
@ -24,7 +13,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- Version in version.h must be kept to match the original bootloader, - Version in version.h must be kept to match the original bootloader,
otherwise firmware update will fail (bootloader will look too old) otherwise firmware update will fail (bootloader will look too old)
## 1.0.0 [Aug 2020] ## 1.0.0 [August 2020]
### Added ### Added
- Initial version - Initial version

1
core/embed/bootloader_ci/CHANGELOG.unreleased Symbolic link
View File

@ -0,0 +1 @@
../../../tools/generate-changelog-unreleased.sh

1
core/embed/bootloader_ci/towncrier.toml Symbolic link
View File

@ -0,0 +1 @@
../../../tools/towncrier.toml

6
docs/misc/changelog.md
View File

@ -3,12 +3,16 @@
Our releases are accompanied by changelogs based on the Our releases are accompanied by changelogs based on the
[Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format. We are using [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format. We are using
the [towncrier](https://github.com/twisted/towncrier) utility to generate them the [towncrier](https://github.com/twisted/towncrier) utility to generate them
at the time a new version is released. There are currently four such changelogs at the time a new version is released. There are currently 8 such changelogs
for different components of the repository: for different components of the repository:
* **[`core/CHANGELOG.md`](https://github.com/trezor/trezor-firmware/blob/master/core/CHANGELOG.md)** for Trezor T firmware * **[`core/CHANGELOG.md`](https://github.com/trezor/trezor-firmware/blob/master/core/CHANGELOG.md)** for Trezor T firmware
* **[`core/embed/boardloader/CHANGELOG.md`](https://github.com/trezor/trezor-firmware/blob/master/core/embed/boardloader/CHANGELOG.md)** for Trezor T boardloader
* **[`core/embed/bootloader/CHANGELOG.md`](https://github.com/trezor/trezor-firmware/blob/master/core/embed/bootloader/CHANGELOG.md)** for Trezor T bootloader
* **[`core/embed/bootloader_ci/CHANGELOG.md`](https://github.com/trezor/trezor-firmware/blob/master/core/embed/bootloader_ci/CHANGELOG.md)** for Trezor T CI bootloader
* **[`legacy/firmware/CHANGELOG.md`](https://github.com/trezor/trezor-firmware/blob/master/legacy/firmware/CHANGELOG.md)** for Trezor 1 firmware * **[`legacy/firmware/CHANGELOG.md`](https://github.com/trezor/trezor-firmware/blob/master/legacy/firmware/CHANGELOG.md)** for Trezor 1 firmware
* **[`legacy/bootloader/CHANGELOG.md`](https://github.com/trezor/trezor-firmware/blob/master/legacy/bootloader/CHANGELOG.md)** for Trezor 1 bootloader * **[`legacy/bootloader/CHANGELOG.md`](https://github.com/trezor/trezor-firmware/blob/master/legacy/bootloader/CHANGELOG.md)** for Trezor 1 bootloader
* **[`legacy/intermediate_fw/CHANGELOG.md`](https://github.com/trezor/trezor-firmware/blob/master/legacy/intermediate_fw/CHANGELOG.md)** for Trezor 1 intermediate firmware
* **[`python/CHANGELOG.md`](https://github.com/trezor/trezor-firmware/blob/master/python/CHANGELOG.md)** for Python client library * **[`python/CHANGELOG.md`](https://github.com/trezor/trezor-firmware/blob/master/python/CHANGELOG.md)** for Python client library
## Adding changelog entry ## Adding changelog entry

1
legacy/intermediate_fw/.changelog.d/.gitignore vendored Normal file
View File

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

1
legacy/intermediate_fw/.towncrier.template.md Symbolic link
View File

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

16
legacy/intermediate_fw/CHANGELOG.md
View File

@ -4,24 +4,12 @@ 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/). The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [Unreleased] ## 1.9.0 [February 2021]
### Added
### Deprecated
### Removed
### Fixed
### Security
## 1.9.0 [Feb 2021]
### Added ### Added
- Update bootloader to 1.9.0 - Update bootloader to 1.9.0
## 1.8.0 [Jun 2021] ## 1.8.0 [June 2021]
### Added ### Added
- Initial version of intermediate firmware - Initial version of intermediate firmware

1
legacy/intermediate_fw/CHANGELOG.unreleased Symbolic link
View File

@ -0,0 +1 @@
../../tools/generate-changelog-unreleased.sh

1
legacy/intermediate_fw/towncrier.toml Symbolic link
View File

@ -0,0 +1 @@
../../tools/towncrier.toml

7
tools/generate-changelog.py
View File

@ -79,7 +79,12 @@ def current_date(project):
parts = project.parts parts = project.parts
today = datetime.datetime.now() today = datetime.datetime.now()
if parts[-2:] == ("legacy", "bootloader"): if (
parts[-3:] == ("core", "embed", "bootloader")
or parts[-3:] == ("core", "embed", "bootloader_ci")
or parts[-2:] == ("legacy", "bootloader")
or parts[-2:] == ("legacy", "intermediate_fw")
):
return today.strftime("%B %Y") return today.strftime("%B %Y")
elif parts[-1] == "python": elif parts[-1] == "python":
return today.strftime("%Y-%m-%d") return today.strftime("%Y-%m-%d")