1
0
mirror of https://github.com/trezor/trezor-firmware.git synced 2025-01-21 04:41:18 +00:00

docs: make sure changelog fragments end with a period

Also, run `generate-changelog.py` over prodtest changelog.

[no changelog]
This commit is contained in:
Roman Zeyde 2025-01-16 11:06:11 +02:00
parent 00740b560c
commit e9aca68612
24 changed files with 45 additions and 22 deletions

View File

@ -56,6 +56,7 @@ changelog_check: ## check changelog format
./tools/generate-changelog.py --check core/embed/projects/boardloader ./tools/generate-changelog.py --check core/embed/projects/boardloader
./tools/generate-changelog.py --check core/embed/projects/bootloader ./tools/generate-changelog.py --check core/embed/projects/bootloader
./tools/generate-changelog.py --check core/embed/projects/bootloader_ci ./tools/generate-changelog.py --check core/embed/projects/bootloader_ci
./tools/generate-changelog.py --check core/embed/projects/prodtest
./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/firmware
./tools/generate-changelog.py --check legacy/intermediate_fw ./tools/generate-changelog.py --check legacy/intermediate_fw

View File

@ -1 +1 @@
[T2B1, T3B1] Fix "PIN attempts exceeded" screen [T2B1, T3B1] Fix "PIN attempts exceeded" screen.

View File

@ -1 +1 @@
Fix auto-mover hitting wall scenario Fix auto-mover hitting wall scenario.

View File

@ -1 +1 @@
[T3T1] Fix unexpected info button when confirming passphrase coming from host [T3T1] Fix unexpected info button when confirming passphrase coming from host.

View File

@ -1 +1 @@
STWLC38 nvm patch and config update from host STWLC38 nvm patch and config update from host.

View File

@ -1 +1 @@
[T2T1] Fix wrong RSOD color on some older Model T devices [T2T1] Fix wrong RSOD color on some older Model T devices.

View File

@ -1 +1 @@
Bootloader redesign Bootloader redesign.

View File

@ -1 +1 @@
Add basic Trezor Model R hardware support Add basic Trezor Model R hardware support.

View File

@ -1 +1 @@
Using hardware acceleration (dma2d) for rendering Using hardware acceleration (dma2d) for rendering.

View File

@ -1 +1 @@
Add model info to image and check when installing/running firmware Add model info to image and check when installing/running firmware.

View File

@ -1 +1 @@
Added basic support for STM32U5 Added basic support for STM32U5.

View File

@ -1 +1 @@
Fix BOOTLOADER VERSION command Fix BOOTLOADER VERSION command.

View File

@ -39,7 +39,8 @@ Changelog](https://keepachangelog.com/en/1.0.0/) format:
* `incompatible` (for backwards incompatible changes) * `incompatible` (for backwards incompatible changes)
Entries are added by creating files in the `.changelog.d` directory where the Entries are added by creating files in the `.changelog.d` directory where the
file name is `<number>.<type>` and contains single line describing the change. file name is `<number>.<type>` and contains single line describing the change,
ending with a period.
As an example, an entry describing bug fix for issue 1234 in Trezor T firmware As an example, an entry describing bug fix for issue 1234 in Trezor T firmware
is added by creating file `core/.changelog.d/1234.fixed`. The file can be is added by creating file `core/.changelog.d/1234.fixed`. The file can be
formatted with markdown. If more entries are desired for single issue number and formatted with markdown. If more entries are desired for single issue number and

View File

@ -1 +1 @@
Signed Ethereum network and token definitions from host Signed Ethereum network and token definitions from host.

View File

@ -1 +1 @@
CoSi functionality CoSi functionality.

View File

@ -1 +1 @@
MUE support MUE support.

View File

@ -1 +1 @@
Unchained paths for p2wsh multisig Unchained paths for p2wsh multisig.

View File

@ -1 +1 @@
Bootloader VTOR and FW handover fix Bootloader VTOR and FW handover fix.

View File

@ -1 +1 @@
CoSi functionality CoSi functionality.

View File

@ -1 +1 @@
Added support for T3B1 Added support for T3B1.

View File

@ -1 +1 @@
Enum for valid device rotations Enum for valid device rotations.

View File

@ -1 +1 @@
Added pretty-printing of protobuf messages in IPython (`_repr_pretty_`) Added pretty-printing of protobuf messages in IPython (`_repr_pretty_`).

View File

@ -1 +1 @@
`device.reset()` is deprecated, migrate to `device.setup()` `device.reset()` is deprecated, migrate to `device.setup()`.

View File

@ -17,6 +17,8 @@ MODELS_RE = re.compile(r"\[([A-Z0-9]{4})(,[A-Z0-9]{4})*\][ ]?")
INTERNAL_MODELS = ("T2T1", "T2B1", "T3B1", "T3T1", "D001") INTERNAL_MODELS = ("T2T1", "T2B1", "T3B1", "T3T1", "D001")
INTERNAL_MODELS_SKIP = ("D001",) INTERNAL_MODELS_SKIP = ("D001",)
IGNORED_FILES = ('.gitignore', '.keep')
def linkify_changelog(changelog_file: Path, only_check: bool = False) -> bool: def linkify_changelog(changelog_file: Path, only_check: bool = False) -> bool:
links = {} links = {}
@ -116,6 +118,23 @@ def filter_changelog(changelog_file: Path, internal_name: str):
destination.write(res) destination.write(res)
def check_style(project: Path):
success = True
fragements_dir = project / ".changelog.d"
for fragment in fragements_dir.iterdir():
if fragment.name in IGNORED_FILES:
continue
fragment_text = fragment.read_text().rstrip()
if not fragment_text.endswith("."):
click.echo(f"Fragment '{fragment}' must end with a period.")
success = False
if not success:
raise click.ClickException("Fragment style check failed.")
else:
click.echo("Fragment style check passed.")
def generate_filtered(project: Path, changelog: Path): def generate_filtered(project: Path, changelog: Path):
if project.parts[-1] != "core": if project.parts[-1] != "core":
return return
@ -153,6 +172,8 @@ def cli(project, version, date, check, only_models):
- Tell git to stage changed files. - Tell git to stage changed files.
""" """
project = Path(project) project = Path(project)
check_style(project)
changelog = project / "CHANGELOG.md" changelog = project / "CHANGELOG.md"
if not changelog.exists(): if not changelog.exists():