From 412d06fdfe4da525a6b14d0a41728ded3291c213 Mon Sep 17 00:00:00 2001 From: Martin Milata Date: Tue, 22 Jun 2021 00:43:04 +0200 Subject: [PATCH] docs(core+legacy): use towncrier for generating CHANGELOG.md core/embed/boardloader/CHANGELOG.md core/embed/bootloader/CHANGELOG.md core/embed/bootloader_ci/CHANGELOG.md legacy/intermediate_fw/CHANGELOG.md --- Makefile | 8 ++++++-- ci/check_changelog.sh | 2 +- .../embed/boardloader/.changelog.d/.gitignore | 1 + core/embed/boardloader/.towncrier.template.md | 1 + core/embed/boardloader/CHANGELOG.md | 12 ----------- core/embed/boardloader/CHANGELOG.unreleased | 1 + core/embed/boardloader/towncrier.toml | 1 + core/embed/bootloader/.changelog.d/.gitignore | 1 + core/embed/bootloader/.towncrier.template.md | 1 + core/embed/bootloader/CHANGELOG.md | 20 +++---------------- core/embed/bootloader/CHANGELOG.unreleased | 1 + core/embed/bootloader/towncrier.toml | 1 + .../bootloader_ci/.changelog.d/.gitignore | 1 + .../bootloader_ci/.towncrier.template.md | 1 + core/embed/bootloader_ci/CHANGELOG.md | 15 ++------------ core/embed/bootloader_ci/CHANGELOG.unreleased | 1 + core/embed/bootloader_ci/towncrier.toml | 1 + docs/misc/changelog.md | 6 +++++- .../intermediate_fw/.changelog.d/.gitignore | 1 + legacy/intermediate_fw/.towncrier.template.md | 1 + legacy/intermediate_fw/CHANGELOG.md | 16 ++------------- legacy/intermediate_fw/CHANGELOG.unreleased | 1 + legacy/intermediate_fw/towncrier.toml | 1 + tools/generate-changelog.py | 7 ++++++- 24 files changed, 41 insertions(+), 61 deletions(-) create mode 100644 core/embed/boardloader/.changelog.d/.gitignore create mode 120000 core/embed/boardloader/.towncrier.template.md create mode 120000 core/embed/boardloader/CHANGELOG.unreleased create mode 120000 core/embed/boardloader/towncrier.toml create mode 100644 core/embed/bootloader/.changelog.d/.gitignore create mode 120000 core/embed/bootloader/.towncrier.template.md create mode 120000 core/embed/bootloader/CHANGELOG.unreleased create mode 120000 core/embed/bootloader/towncrier.toml create mode 100644 core/embed/bootloader_ci/.changelog.d/.gitignore create mode 120000 core/embed/bootloader_ci/.towncrier.template.md create mode 120000 core/embed/bootloader_ci/CHANGELOG.unreleased create mode 120000 core/embed/bootloader_ci/towncrier.toml create mode 100644 legacy/intermediate_fw/.changelog.d/.gitignore create mode 120000 legacy/intermediate_fw/.towncrier.template.md create mode 120000 legacy/intermediate_fw/CHANGELOG.unreleased create mode 120000 legacy/intermediate_fw/towncrier.toml diff --git a/Makefile b/Makefile index faff63bde..6869a5160 100644 --- a/Makefile +++ b/Makefile @@ -41,9 +41,13 @@ pystyle: ## apply code style on application sources and tests changelog_check: ## check changelog format ./tools/generate-changelog.py --check core - ./tools/generate-changelog.py --check python - ./tools/generate-changelog.py --check legacy/firmware + ./tools/generate-changelog.py --check core/embed/boardloader + ./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/firmware + ./tools/generate-changelog.py --check legacy/intermediate_fw + ./tools/generate-changelog.py --check python yaml_check: ## check yaml formatting yamllint . diff --git a/ci/check_changelog.sh b/ci/check_changelog.sh index c50db30d2..011fd3214 100755 --- a/ci/check_changelog.sh +++ b/ci/check_changelog.sh @@ -2,7 +2,7 @@ base_branch=master 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) trap 'rm -- $changed_files' EXIT diff --git a/core/embed/boardloader/.changelog.d/.gitignore b/core/embed/boardloader/.changelog.d/.gitignore new file mode 100644 index 000000000..f935021a8 --- /dev/null +++ b/core/embed/boardloader/.changelog.d/.gitignore @@ -0,0 +1 @@ +!.gitignore diff --git a/core/embed/boardloader/.towncrier.template.md b/core/embed/boardloader/.towncrier.template.md new file mode 120000 index 000000000..a8bbd1d22 --- /dev/null +++ b/core/embed/boardloader/.towncrier.template.md @@ -0,0 +1 @@ +../../../tools/towncrier.template.md \ No newline at end of file diff --git a/core/embed/boardloader/CHANGELOG.md b/core/embed/boardloader/CHANGELOG.md index 2c1df3ff0..aa5566a44 100644 --- a/core/embed/boardloader/CHANGELOG.md +++ b/core/embed/boardloader/CHANGELOG.md @@ -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/). -## [Unreleased] - -### Added - -### Deprecated - -### Removed - -### Fixed - -### Security - diff --git a/core/embed/boardloader/CHANGELOG.unreleased b/core/embed/boardloader/CHANGELOG.unreleased new file mode 120000 index 000000000..5128a0ac2 --- /dev/null +++ b/core/embed/boardloader/CHANGELOG.unreleased @@ -0,0 +1 @@ +../../../tools/generate-changelog-unreleased.sh \ No newline at end of file diff --git a/core/embed/boardloader/towncrier.toml b/core/embed/boardloader/towncrier.toml new file mode 120000 index 000000000..090013b7d --- /dev/null +++ b/core/embed/boardloader/towncrier.toml @@ -0,0 +1 @@ +../../../tools/towncrier.toml \ No newline at end of file diff --git a/core/embed/bootloader/.changelog.d/.gitignore b/core/embed/bootloader/.changelog.d/.gitignore new file mode 100644 index 000000000..f935021a8 --- /dev/null +++ b/core/embed/bootloader/.changelog.d/.gitignore @@ -0,0 +1 @@ +!.gitignore diff --git a/core/embed/bootloader/.towncrier.template.md b/core/embed/bootloader/.towncrier.template.md new file mode 120000 index 000000000..a8bbd1d22 --- /dev/null +++ b/core/embed/bootloader/.towncrier.template.md @@ -0,0 +1 @@ +../../../tools/towncrier.template.md \ No newline at end of file diff --git a/core/embed/bootloader/CHANGELOG.md b/core/embed/bootloader/CHANGELOG.md index ea3c4169e..23d46e682 100644 --- a/core/embed/bootloader/CHANGELOG.md +++ b/core/embed/bootloader/CHANGELOG.md @@ -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/). -## [Unreleased] -### Added - -### Deprecated - -### Removed - -### Fixed - -### Security - - ------------- - -## 2.0.3 [Mar 2019] +## 2.0.3 [March 2019] ### Security - Enable MPU - Introduce delays to USB stack -## 2.0.2 [Dec 2018] +## 2.0.2 [December 2018] ### Added - Support for a new display driver -## 2.0.1 [Feb 2018] +## 2.0.1 [February 2018] ### Added - First public release diff --git a/core/embed/bootloader/CHANGELOG.unreleased b/core/embed/bootloader/CHANGELOG.unreleased new file mode 120000 index 000000000..5128a0ac2 --- /dev/null +++ b/core/embed/bootloader/CHANGELOG.unreleased @@ -0,0 +1 @@ +../../../tools/generate-changelog-unreleased.sh \ No newline at end of file diff --git a/core/embed/bootloader/towncrier.toml b/core/embed/bootloader/towncrier.toml new file mode 120000 index 000000000..090013b7d --- /dev/null +++ b/core/embed/bootloader/towncrier.toml @@ -0,0 +1 @@ +../../../tools/towncrier.toml \ No newline at end of file diff --git a/core/embed/bootloader_ci/.changelog.d/.gitignore b/core/embed/bootloader_ci/.changelog.d/.gitignore new file mode 100644 index 000000000..f935021a8 --- /dev/null +++ b/core/embed/bootloader_ci/.changelog.d/.gitignore @@ -0,0 +1 @@ +!.gitignore diff --git a/core/embed/bootloader_ci/.towncrier.template.md b/core/embed/bootloader_ci/.towncrier.template.md new file mode 120000 index 000000000..a8bbd1d22 --- /dev/null +++ b/core/embed/bootloader_ci/.towncrier.template.md @@ -0,0 +1 @@ +../../../tools/towncrier.template.md \ No newline at end of file diff --git a/core/embed/bootloader_ci/CHANGELOG.md b/core/embed/bootloader_ci/CHANGELOG.md index 218063084..f064fc019 100644 --- a/core/embed/bootloader_ci/CHANGELOG.md +++ b/core/embed/bootloader_ci/CHANGELOG.md @@ -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/). -## [Unreleased] -### Added - -### Deprecated - -### Removed - -### Fixed - -### Security - -## 1.0.1 [Jan 2021] +## 1.0.1 [January 2021] ### Added - 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, otherwise firmware update will fail (bootloader will look too old) -## 1.0.0 [Aug 2020] +## 1.0.0 [August 2020] ### Added - Initial version diff --git a/core/embed/bootloader_ci/CHANGELOG.unreleased b/core/embed/bootloader_ci/CHANGELOG.unreleased new file mode 120000 index 000000000..5128a0ac2 --- /dev/null +++ b/core/embed/bootloader_ci/CHANGELOG.unreleased @@ -0,0 +1 @@ +../../../tools/generate-changelog-unreleased.sh \ No newline at end of file diff --git a/core/embed/bootloader_ci/towncrier.toml b/core/embed/bootloader_ci/towncrier.toml new file mode 120000 index 000000000..090013b7d --- /dev/null +++ b/core/embed/bootloader_ci/towncrier.toml @@ -0,0 +1 @@ +../../../tools/towncrier.toml \ No newline at end of file diff --git a/docs/misc/changelog.md b/docs/misc/changelog.md index f92a03bac..5e2a647d2 100644 --- a/docs/misc/changelog.md +++ b/docs/misc/changelog.md @@ -3,12 +3,16 @@ Our releases are accompanied by changelogs based on the [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 -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: * **[`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/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 ## Adding changelog entry diff --git a/legacy/intermediate_fw/.changelog.d/.gitignore b/legacy/intermediate_fw/.changelog.d/.gitignore new file mode 100644 index 000000000..f935021a8 --- /dev/null +++ b/legacy/intermediate_fw/.changelog.d/.gitignore @@ -0,0 +1 @@ +!.gitignore diff --git a/legacy/intermediate_fw/.towncrier.template.md b/legacy/intermediate_fw/.towncrier.template.md new file mode 120000 index 000000000..8b2805a03 --- /dev/null +++ b/legacy/intermediate_fw/.towncrier.template.md @@ -0,0 +1 @@ +../../tools/towncrier.template.md \ No newline at end of file diff --git a/legacy/intermediate_fw/CHANGELOG.md b/legacy/intermediate_fw/CHANGELOG.md index 6a5f5556b..5f79e7b4a 100644 --- a/legacy/intermediate_fw/CHANGELOG.md +++ b/legacy/intermediate_fw/CHANGELOG.md @@ -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/). -## [Unreleased] - -### Added - -### Deprecated - -### Removed - -### Fixed - -### Security - -## 1.9.0 [Feb 2021] +## 1.9.0 [February 2021] ### Added - Update bootloader to 1.9.0 -## 1.8.0 [Jun 2021] +## 1.8.0 [June 2021] ### Added - Initial version of intermediate firmware diff --git a/legacy/intermediate_fw/CHANGELOG.unreleased b/legacy/intermediate_fw/CHANGELOG.unreleased new file mode 120000 index 000000000..075dc6055 --- /dev/null +++ b/legacy/intermediate_fw/CHANGELOG.unreleased @@ -0,0 +1 @@ +../../tools/generate-changelog-unreleased.sh \ No newline at end of file diff --git a/legacy/intermediate_fw/towncrier.toml b/legacy/intermediate_fw/towncrier.toml new file mode 120000 index 000000000..c665cbc4d --- /dev/null +++ b/legacy/intermediate_fw/towncrier.toml @@ -0,0 +1 @@ +../../tools/towncrier.toml \ No newline at end of file diff --git a/tools/generate-changelog.py b/tools/generate-changelog.py index 1e501ce44..966010a72 100755 --- a/tools/generate-changelog.py +++ b/tools/generate-changelog.py @@ -79,7 +79,12 @@ def current_date(project): parts = project.parts 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") elif parts[-1] == "python": return today.strftime("%Y-%m-%d")