neurobagel / neurobagel/dev-docs
Document dependabot PR handling to ensure they don't end up in the changelog
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
We use the omit-commits auto plugin to exclude bot PRs from the changelog:
However, when we merge a bot PR using a merge commit instead of squashing, we can end up with a situation where not all commits from the PR are associated with the bot. As a result, the PR as a whole might still end up in the changelog.
Example: https://github.com/neurobagel/annotation-tool/releases/tag/v0.4.5
Solutions:
- Squash rather than merge commit where ever possible
- Ensure that dependabot[bot] is an author in the commit message (usually the default)
- We can make dependabot add the
skip-releaselabel to all PRs
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked .autorc_default configuration and the v0.4.5 release example to understand how Dependabot commits enter the changelog. Document the agreed handling in the development documentation, covering squash merges, the dependabot[bot] author, and the skip-release label; it is done when contributors have clear guidance for avoiding these entries.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100