Defame1297
e455c68fe4
Covers list_pull_requests, pull_request_read, pull_request_write, and pull_request_review_write, split out of the flat plugins/bin/skills/gitea PR-dispatch logic per ADR 0011. Composes gitea-labels-milestones for label/milestone ID resolution instead of duplicating that lookup. Tool signatures were cross-checked live via ToolSearch against the deployed gitea-mcp server rather than copied from api-reference.md, per the ADR's schema-drift mitigation process.
42 lines
3.8 KiB
Markdown
42 lines
3.8 KiB
Markdown
---
|
|
topic: merging
|
|
source_keys:
|
|
- gitea-mcp-repo
|
|
- context7-websites-gitea
|
|
- context7-gitea-tea-cli
|
|
---
|
|
|
|
# Merge workflow
|
|
|
|
## Two independent gates
|
|
|
|
Before merging, two things can each independently block the merge, and only one of them is visible from `get_status`:
|
|
|
|
1. **CI status** — `pull_request_read method: "get_status"` returns the combined commit status for the PR's head commit. This reflects CI/build checks only.
|
|
2. **Review and branch-protection state** — required approval counts, an allowlist of required approvers/teams, whether requested reviewers have reviewed, and stale-approval handling (an approval given before new commits were pushed may be auto-dismissed or ignored, depending on repo settings). None of this is exposed via `get_status` — it is enforced server-side by the merge call itself, and repository admins are not exempt from it by default (an explicit "administrators must follow branch protection" setting is what removes that bypass).
|
|
|
|
A green `get_status` does not mean the merge will succeed. Treat both gates as independently checkable, and expect `pull_request_write method: "merge"` to return an error if branch-protection requirements aren't met even when CI is passing.
|
|
|
|
## `pull_request_write method: "merge"`
|
|
|
|
**Parameters** (in addition to `owner`, `repo`, `pull_number` — see `references/pull-requests.md` for the full parameter list):
|
|
- `merge_style` (string, optional, default `"merge"`) — `"merge"` | `"rebase"` | `"rebase-merge"` | `"squash"` | `"fast-forward-only"`
|
|
- `title` (string, optional) — override the merge/squash commit's title
|
|
- `message` (string, optional) — merge commit message (for squash, this becomes the squash commit's message — see the auto-close gotcha below)
|
|
- `delete_branch` (boolean, optional) — delete the head branch after a successful merge
|
|
- `force_merge` (boolean, optional) — merge even if checks are failing; use only when the user explicitly asks to override a failing CI status
|
|
- `merge_when_checks_succeed` (boolean, optional) — queue the merge to happen automatically once checks pass, instead of merging immediately
|
|
- `head_commit_id` (string, optional) — expected head SHA; supplying it lets the server detect if the branch moved since you last read it (conflict detection) rather than merging a stale diff
|
|
|
|
## Recommended sequence
|
|
|
|
1. Call `pull_request_read method: "get_status"` first. Report CI status to the user. Do not block the merge attempt solely because CI is failing unless the user asks you to stop — but do surface it before proceeding.
|
|
2. Call `pull_request_write method: "merge"` with the chosen `merge_style` (ask the user if unspecified; do not default to squash silently, since squash has the closing-keyword implication below) and `delete_branch: true` unless told otherwise.
|
|
3. If branch-protection requirements block the merge, the call itself will return the error — report it verbatim rather than retrying with `force_merge` unless the user explicitly asks to override.
|
|
|
|
## Merging does not auto-close linked issues
|
|
|
|
Gitea has no GitHub-style "merge triggers close" event. It does parse closing keywords (`Fixes #N`, `Closes #N`) in commit messages that land on the default branch — so a regular (non-squash) merge, which preserves each original commit message, can auto-close an issue this way if one of those commits used a closing keyword. A squash merge rewrites history into a single commit, so whether the keyword survives depends entirely on what `message` (or the default squash message) ends up being.
|
|
|
|
After any merge, call `issue_read method: "get"` (in `gitea-issues`) on any issue the PR references before deciding whether to close it explicitly. Closing an already-closed issue is a harmless no-op, but don't assume a manual close is always needed, and don't assume it never is.
|