Skip to content

Commit 15cff37

Browse files
committed
Add skipped commit to the glossary
A commit to backport whose changes the target branch already contains is now dropped from the cherry-pick and named in the comments. That makes it a category of commit users see, so it gets a term, unlike the other outcome adjectives which stay plain English. The term is scoped to commits to backport. Merge commits left out by `merge_commits: skip` never become commits to backport, so they are excluded rather than skipped; the input value keeps its frozen name. Skipped commits also break the one-to-one mapping from commits to backport to cherry-picked commits, and when every commit is skipped no backport pull request is created, so the relationships say so.
1 parent 54c8afc commit 15cff37

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

‎CONTEXT.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ The set of commits selected from the original pull request's history and passed
2727
**Cherry-picked commits**:
2828
The new commits created on the target branch by `git cherry-pick`. The commit author is preserved from the input commits; the commit committer is overwritten by `git_committer_name` / `git_committer_email` (defaulting to `github-actions[bot]`). Each carries an `-x` trailer referencing the input commit as audit trail.
2929

30+
**Skipped commit**:
31+
A commit to backport whose changes the target branch already contains, so no cherry-picked commit is created for it.
32+
_Avoid_: empty commit, empty cherry-pick (git mechanics), already-backported commit (the changes may have reached the target another way)
33+
3034
**Merge method**:
3135
How a pull request is merged on GitHub. One of: squash-and-merge, rebase-and-merge, or merge commit. The action *observes* the original pull request's merge method (consumed by `cherry_picking: auto`) and *configures* the backport pull request's merge method (via `auto_merge_method`). Always disambiguate which pull request's merge method is meant.
3236

@@ -46,7 +50,8 @@ Git commit metadata. Cherry-picking preserves the commit author and overwrites t
4650
- An **original pull request** produces zero or more **backport pull requests**, one per attempted **target branch**.
4751
- A **backport pull request** lives on a **target branch** inside the **target repository**.
4852
- A **backport label** on the **original pull request** selects one **target branch**.
49-
- The **commits to backport** (input to cherry-pick) become **cherry-picked commits** (output, on the target branch) after `git cherry-pick`.
53+
- The **commits to backport** (input to cherry-pick) become **cherry-picked commits** (output, on the target branch) after `git cherry-pick`, except for **skipped commits**.
54+
- When every commit to backport is a **skipped commit**, no **backport pull request** is created for that **target branch**.
5055
- The **original pull request's** **merge method** determines which **commits to backport** are selected when `cherry_picking: auto`.
5156

5257
## Example dialogue
@@ -62,4 +67,5 @@ Git commit metadata. Cherry-picking preserves the commit author and overwrites t
6267
- "Downstream repo" — resolved to **target repository** in prose. Input names `downstream_repo`/`downstream_owner` are experimental and likely renamed on promotion.
6368
- "Merge commit" was overloaded across: a merge method, an intermediate commit in PR history (`merge_commits` input), and the result of auto-merge. Resolved by always pairing with context; no coined term for the intermediate case.
6469
- "Author" was used for three concepts: PR author, commit author, commit committer. Resolved by always qualifying ("PR author" / "commit author" / "commit committer").
65-
- "Successful" / "failed" / "skipped" / "attempted" — intentionally *not* glossarised. The output `was_successful` is documented precisely in `README.md`; surrounding adjectives are plain English.
70+
- "Successful" / "failed" / "skipped" / "attempted" — intentionally *not* glossarised. The output `was_successful` is documented precisely in `README.md`; surrounding adjectives are plain English. The one exception is **skipped commit**, a named category of commit.
71+
- "Skipped" merge commits: `merge_commits: skip` leaves merge commits out of the **commits to backport**. They are *excluded*, not **skipped commits**. The input value `skip` is frozen API; in prose, say "excluded" or "ignored".

0 commit comments

Comments
 (0)