Changelog Auto-Updater #422
Conversation
This new helper script takes a branch name as input, then fetches `CHANGELOG.md` from that branch in the upstream mixxxdj/mixxx repo, converts the changelog into sphinx's ReStructured Text format and writes it to `source/chapters/appendix/version_history.py`. This makes keeping the manual repository changelog in sync with the code repository changelog much easier and will allow automation in the future.
See corresponding PR mixxxdj/manual#422 for details. This requires a Personal Acess Token (PAT) with the `public_repo` scope in the repository secrets (named `MANUAL_REPO_TOKEN`).
See corresponding PR mixxxdj/manual#422 for details. This requires a Personal Acess Token (PAT) with the `public_repo` scope in the repository secrets (named `MANUAL_REPO_TOKEN`).
|
Here's an example:
|
|
Who can add the repo secret? @daschuer maybe? |
I had just a look in the settings, but I don't know what to do. Do you have some hints? |
See corresponding PR mixxxdj/manual#422 for details. This requires a Personal Acess Token (PAT) with the `public_repo` scope in the repository secrets (named `MIXXXBOT_CHANGELOG_AUTOUPDATER_PAT`).
Holzhaus
force-pushed
the
changelog-updater
branch
from
eab397a
to
9b6c85c
Compare
This workflow can be triggered using a personal access token (PAT) with
the `public_repo` scope.
$ curl -H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <your-token>" \
--request POST \
--data '{"event_type": "update-changelog", "client_payload": {"branch": "2.3"}}' \
https://api.github.com/repos/mixxxdj/manual/dispatches
It will then run `tools/update_changelog.py` and if any files were
changed, it will commit these changes and then trigger rebuild of the
manual.
For the latter to work, a `MIXXXBOT_CHANGELOG_AUTOUPDATER_PAT`
repository secret needs to be present, because the default
`GITHUB_TOKEN` doesn't suffice.
Holzhaus
force-pushed
the
changelog-updater
branch
from
9b6c85c
to
b02d4b1
Compare
|
Ready to merge. Tested on my own repo, here's the commit generated by the bot: Holzhaus@a4b9555 |
See corresponding PR mixxxdj/manual#422 for details. This requires a Personal Acess Token (PAT) with the `public_repo` scope in the repository secrets (named `MIXXXBOT_CHANGELOG_AUTOUPDATER_PAT`).
|
Merge?
|
|
Ping. I suggest to merge this before mixxxdj/mixxx#4210 and mixxxdj/mixxx#4211 so that we can test if it works. |
|
I think this will be hard to maintain later because of some hidden implications. |
|
This introduces some implications the author of the CHANGLOG.md file should be aware of. |
I added some explaining comments, however I'm unsure if this is what you meant.
The implication is that |
|
Ping. |
This is now part of mixxxdj/mixxx#4256.
As requested here: mixxxdj#422 (comment)
As requested here: mixxxdj#422 (comment)
Holzhaus
force-pushed
the
changelog-updater
branch
2 times, most recently
from
39cee02
to
5097ab7
Compare
|
@Swiftb0y: merge? |
|
I suggest we make an exception this time and let @Holzhaus merge both PRs himself in the order they require to be merged. |
|
It works: 52c82e0 |
This already allows automating the changelog updates via repository dispatch. I'll open a corresponding PR on the code repo. Please see the indivial commit messages for details.
To trigger a rebuild automatically, a PAT
REPO_TOKENneeds to be present in the manual repo's secrets, because the defaultGITHUB_TOKENdoesn't to suffice.