Skip to content

changelog: move the Update Changelogs workflow here and fix section headers - #63

Open
KonradBreitsprecherBkd wants to merge 1 commit into
mainfrom
feature/changelog-workflow
Open

KonradBreitsprecherBkd wants to merge 1 commit into
mainfrom
feature/changelog-workflow

Conversation

@KonradBreitsprecherBkd

@KonradBreitsprecherBkd KonradBreitsprecherBkd commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

The Update Changelogs workflow moves from sil-kit-delivery (update_packaging_changelogs.yml) into this repository, next to the files it changes. It also fixes how section headers are handled. Part 3 of 3, independent of #62 and #64.

Workflow

update-changelogs.yml (dispatch) reads docs/changelog/versions/latest.md of vectorgrp/sil-kit at silkit_ref (default main). It adds the entry to debian/changelog and rpm/libsilkit5.spec, pushes update_to_<version> and opens a pull request for review.

  • It runs on github.com with GITHUB_TOKEN. No GitHub App token and no hop from the internal GitHub Enterprise.
  • Author and email are inputs, as before. Generic addresses (sil-kit@…, noreply@…) are rejected.

Converter fix

Only the bullets of the Keep a Changelog sections (Added, Changed, Deprecated, Removed, Fixed, Security) are taken over.

  • Before, a header line was appended to the previous entry. The 5.0.8 entry in debian/changelog and the spec ends one item with … that ships one.# Fixed.
  • Notes, tables and bullets of other sections (e.g. Note on the SIL Kit MSI installer) no longer end up in the package changelogs.

tests/test_changelog_converter.py covers this. Run it with python3 -m unittest discover -s tests -p "test_changelog*.py"; the workflow runs it before converting. A dry run against the real 5.0.8.md gives the expected entries without the stray header.

Notes

  • The organization setting Allow GitHub Actions to create and approve pull requests must be on for gh pr create with GITHUB_TOKEN.
  • Pull requests opened with GITHUB_TOKEN do not start other workflows. This repository has no PR checks today.
  • The delivery side (removal of the old workflow, README) is in sil-kit-delivery#161 (internal).

🤖 Generated with Claude Code

…eaders

The workflow and changelog_converter.py move from sil-kit-delivery
(update_packaging_changelogs.yml) into sil-kit-pkg. It runs on github.com
next to the files it changes, so it needs no GitHub App token and no hop from
the internal GitHub Enterprise; the pull request is opened with GITHUB_TOKEN.

The converter only takes the bullets of the Keep a Changelog sections (Added,
Changed, Deprecated, Removed, Fixed, Security). Before, a section header was
appended to the previous entry ("... ships one.# Fixed" in 5.0.8), and notes
and tables of other sections could end up in the package changelogs.
tests/test_changelog_converter.py covers this.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant