nf-core-bot
The nf-core-bot can automate code fixes and other actions in pull requests. You trigger these commands by commenting on the PR with specific keywords.
Command availability varies by repository. Check the repository’s .github/workflows/ directory to see which bot commands are configured.
Available commands
@nf-core-bot fix linting
When prettier reports code formatting issues, you can automatically fix them by commenting:
@nf-core-bot fix lintingThis will start a GitHub Actions workflow that will:
- React with 👀
- Run prettier
- Commit changes
- Push them to the repository
- React with 👍🏻 if everything goes well
Available for:
@nf-core-bot update gpu snapshot path: $PATH
To update outdated nf-test snapshots for GPU-based tests, comment on the PR:
@nf-core-bot update gpu snapshot path: $PATHReplace $PATH with the path to the test file. For example, modules/nf-core/parabricks/applybqsr/tests/main.nf.test.
The workflow will:
- React with 👀
- Update the snapshots
- Commit and push the changes
- React with 🎉 on success
Available for: nf-core/modules.
@nf-core-bot update changelog
To update the auto-generated changelog entry with a new PR title, comment:
@nf-core-bot update changelog $NEW_TITLEThis updates the changelog entry using the PR title, or the value of $NEW_TITLE if provided.
Available for nf-core/tools.
@nf-core-bot update snapshots
When Textual snapshot tests fail (from tests/pipelines/test_crate_app.py), an HTML report is generated and uploaded as an artifact. To automatically update the snapshots, comment:
@nf-core-bot update snapshotsAlways review the HTML report to verify the changes are expected before merging.
Available for nf-core/tools.