Add action to populate the change log from PR titles triggered by @multiqc-bot changelog
#2025
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* GitHub workflow that appends to a changelog * Clean up changelog * No need to install MultiQC and load module, can just parse the python file
ewels
reviewed
Sep 4, 2023
There was a problem hiding this comment.
Amazing stuff 🤩
Bonus points in the workflow YAML:
- Don't run if
CHANGELOG.mdhas been modified within the pull request (?) - Add a comment on the PR with the stderr output from the script, saying what happened
- This will alert us to errors, as otherwise we'd need to go in and check the actions logs manually I think
- If we include the git commit hash of the pushed commit, it will make it easy to quickly view the diff of the automated update, for sanity checking
ewels
reviewed
Sep 4, 2023
This reverts commit 5cdcaff.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
vladsavelyev
changed the title
/changelog
vladsavelyev
changed the title
/changelog@multiqc-bot changelog
|
Alright, it works now. Tested here vladsavelyev#21 :) |
ewels
requested changes
Sep 26, 2023
ewels
reviewed
Sep 26, 2023
There was a problem hiding this comment.
It would be good to document how this works for the developer in https://multiqc.info/docs/development/contributing/
|
🚀 Deployed on https://mqc-pr-2025--multiqc.netlify.app |
vladsavelyev
commented
Sep 27, 2023
a-frantz
added a commit
to a-frantz/MultiQC
that referenced
this pull request
Oct 2, 2023
* master: Just run CI on the oldest + newest supported Python versions (MultiQC#2074) Picard: fix parsing mixed strings/numbers, account for trailing tab (MultiQC#2083) FastQC: add top overrepresented sequences table (MultiQC#2075) Add GitHub Actions bot workflow to fix code linting from a PR comment (MultiQC#2082) Use custom exception type instead of `UserWarning` when no samples are found. (MultiQC#2049) Lint modules for missing `self.add_software_version` (MultiQC#2081) Changelog bot: Update docs (MultiQC#2077) Changelog action: remove `.capitalize()`, add changelog entry (MultiQC#2080) Add action to populate the change log from PR titles triggered by `@multiqc-bot changelog` (MultiQC#2025) # Conflicts: # CHANGELOG.md # multiqc/modules/ngsderive/ngsderive.py
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following the discussion.
Add a CI action triggered when a PR is approved.
A new line will be added either under "MultiQC updates", "New Modules", or "Module updates", so it pretty much keeps the existing structure, in it's simplest form (i.e. not separating between classes of core updates). That new line will be committed into the same branch.
I decided not to use any of the existing actions on the marketplace, as configuring them gets too hacky and/or puts too much restrictions.
Updated on 24 Sep 2023:
Triggering a workflow on review approval is not working for forks. Unfortunately such event is triggered on the PR merge branch, so the secrets are not available to the workflow for safety. So working around this by triggering the workflow on a comment. The idea is to support a
@multiqc-bot changelogcommand. The command can take an optional argument. It will trigger a workflow that:@multiqc-bot changelog An amazing change), it will take it as a description; otherwise, takes a changelog entry from the PR title.