Detect bad bullet point indentation in changelog entries #225

New issue

Open

opened 2025-10-14 12:38:17 -05:00 by gilles-peskine-arm · 0 comments

gilles-peskine-arm commented

2025-10-14 12:38:17 -05:00

(Migrated from github.com)

Changelog entries are supposed to start with three spaces, an asterisk and a space. Continuation lines are supposed to be intended with five spaces. That is:

   * First line.
     Second line.

assemble_changelog.py does not enforce the indentation precisely because it's occasionally useful to have lines that are more indented. However, it should enforce more than it currently does.

For example, if a line begins with four spaces and an asterisk, it doesn't get rendered as expected in release notes (where we copy-paste the changelog): assuming the previous line isn't blank (it normally isn't: ), GitHub renders the asterisk as a text element rather than starting new bulleted list entry. This happens occasionally, e.g. “* Add mbedtls_pk_sign_ext() which allows generating RSA-PSS signatures…” and “* Extend the existing PSA_ALG_TLS12_PSK_TO_MS()” in https://github.com/Mbed-TLS/mbedtls/releases/tag/v3.2.0 .

I propose to enforce that every line starts with either " * " or " ".

Changelog entries are supposed to start with three spaces, an asterisk and a space. Continuation lines are supposed to be intended with five spaces. That is: ``` * First line. Second line. ``` `assemble_changelog.py` does not enforce the indentation precisely because it's occasionally useful to have lines that are more indented. However, it should enforce more than it currently does. For example, if a line begins with four spaces and an asterisk, it doesn't get rendered as expected in release notes (where we copy-paste the changelog): assuming the previous line isn't blank (it normally isn't: ), GitHub renders the asterisk as a text element rather than starting new bulleted list entry. This happens occasionally, e.g. “\* Add mbedtls_pk_sign_ext() which allows generating RSA-PSS signatures…” and “\* Extend the existing PSA_ALG_TLS12_PSK_TO_MS()” in https://github.com/Mbed-TLS/mbedtls/releases/tag/v3.2.0 . I propose to enforce that every line starts with either `" * "` or `" "`.

No milestone

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

gh-Mbed-TLS/mbedtls-framework#225

No description provided.

Rows
Columns