feat(stack): add 'mergify stack note' command#1267
Merged
mergify[bot] merged 1 commit intomainfrom Apr 21, 2026
Merged
Conversation
Member
Author
|
This pull request is part of a Mergify stack:
|
Contributor
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 🤖 Continuous IntegrationWonderful, this rule succeeded.
🟢 👀 Review RequirementsWonderful, this rule succeeded.
🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 🔎 ReviewsWonderful, this rule succeeded.
🟢 📕 PR descriptionWonderful, this rule succeeded.
|
There was a problem hiding this comment.
Pull request overview
Adds a new mergify stack note command to attach free-text “why was this commit amended” notes to commits via git-notes, and updates stack setup to make those notes visible in plain git log by configuring notes.displayRef.
Changes:
- Introduce
mergify stack notecommand and implementation for add/append/remove + editor fallback. - Update
stack setupto configurenotes.displayReffor Mergify notes visibility. - Add/adjust tests for the new command and setup behavior; update README command list.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| mergify_cli/stack/note.py | New git-notes based “stack note” implementation (add/append/remove, editor flow). |
| mergify_cli/stack/cli.py | Wire new stack note command into Click CLI. |
| mergify_cli/stack/setup.py | Configure notes.displayRef during stack setup. |
| mergify_cli/tests/stack/test_note.py | New end-to-end style tests for note behavior. |
| mergify_cli/tests/stack/test_setup.py | Extend setup tests to cover/handle notes.displayRef configuration. |
| README.md | Document the new command in the command table. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Attach free-text "why was this commit amended" notes to commits. Notes live in refs/notes/mergify/stack, a dedicated leaf under the refs/notes/mergify/ namespace (sibling to the MQ note refs). `mergify stack setup` appends refs/notes/mergify/* to notes.displayRef so plain `git log` shows all mergify notes (both stack and MQ) automatically. Usage: mergify stack note [-m MESSAGE] [--append] [--remove] [COMMIT] - COMMIT defaults to HEAD; accepts SHA prefix or Change-Id prefix. - -m MESSAGE attaches the note inline; without it, $GIT_EDITOR opens with a template where comment lines (starting with #) are stripped. - --append concatenates to an existing note. - --remove deletes the note (idempotent). This is the first of two PRs for the stack-notes feature. This PR adds the command surface and local visibility via `git log`. A follow-up PR pushes the notes ref to the remote and surfaces the reasons in the revision-history PR comment. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Change-Id: I33cc921fb2caac6a31d2284b2ef76d0429b510ef
jd
force-pushed
the
devs/jd/worktree-git-notes/add-mergify-stack-note-cmd--33cc921f
branch
from
6932dd2 to
b188fe3
Compare
Member
Author
Revision history
|
JulianMaurin
approved these changes
Apr 21, 2026
sileht
approved these changes
Apr 21, 2026
Contributor
Merge Queue Status
This pull request spent 5 minutes 32 seconds in the queue, including 5 minutes 5 seconds running CI. Required conditions to merge
|
36 tasks
mergify
Bot
deleted the
devs/jd/worktree-git-notes/add-mergify-stack-note-cmd--33cc921f
branch
This file contains hidden or 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
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.
Attach free-text "why was this commit amended" notes to commits. Notes
live in refs/notes/mergify/stack, a dedicated leaf under the
refs/notes/mergify/ namespace (sibling to the MQ note refs).
mergify stack setupappends refs/notes/mergify/* to notes.displayRef so plaingit logshows all mergify notes (both stack and MQ) automatically.Usage:
mergify stack note [-m MESSAGE] [--append] [--remove] [COMMIT]
with a template where comment lines (starting with #) are stripped.
This is the first of two PRs for the stack-notes feature. This PR adds
the command surface and local visibility via
git log. A follow-up PRpushes the notes ref to the remote and surfaces the reasons in the
revision-history PR comment.
Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com