Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
github-cherry-pick
Advanced tools
Readme
github-cherry-pick
cherry-picks several commits on a branch using the low level Git Data operations provided by the GitHub REST API.
It's the building block of github-backport
and github-rebase
.
import { cherryPickCommits } from "github-cherry-pick";
const example = async () => {
const newHeadSha = await cherryPickCommits({
// The SHA list of the commits to cherry-pick.
// The commits will be cherry-picked in the order they appear in the array.
// Merge commits are not supported.
// See https://git-scm.com/docs/git-cherry-pick for more details.
commits: [
"8b10a7808f06970232dc1b45a77b47d63641c4f1",
"f393441512c54435819d1cdd8921c0d566911af3",
],
// The name of the branch/reference on top of which the commits will be cherry-picked.
head: "awesome-feature",
// An already authenticated instance of https://www.npmjs.com/package/@octokit/rest.
octokit,
// The username of the repository owner.
owner,
// The name of the repository.
repo,
});
};
github-cherry-pick
can run on Node.js and in recent browsers.
github-cherry-pick
uses debug
to log helpful information at different steps of the cherry-picking process.
To enable these logs, set the DEBUG
environment variable to github-cherry-pick
.
The GitHub REST API doesn't provide a direct endpoint for cherry-picking commits on a branch but it does provide lower level Git operations such as:
It turns out that's all we need to perform a cherry-pick!
Let's say we have this Git state:
* 4620c9b (feature) E
* 317c828 D
* 7599421 C
| * 00ad8d7 (HEAD -> master) B
|/
* 72cc07d A
and we want to cherry-pick 317c828
and 4620c9b
on the master
branch.
github-cherry-pick
would then take the following steps:
temp
branch from master
with POST /repos/:owner/:repo/git/refs.
* 4620c9b (feature) E
* 317c828 D
* 7599421 C
| * 00ad8d7 (HEAD -> temp, master) B
|/
* 72cc07d A
00ad8d7
with 7599421
as parent with POST /repos/:owner/:repo/git/commits and update temp
's reference to point to this new commit with PATCH /repos/:owner/:repo/git/refs/:ref.
* 80c410e (HEAD -> temp) Use tree of 00ad8d7
| * 4620c9b (feature) E
| * 317c828 D
|/
* 7599421 C
| * 00ad8d7 (master) B
|/
* 72cc07d A
317c828
on temp
with POST /repos/:owner/:repo/merges.
* 55a7299 (HEAD -> temp) Merge commit '317c828' into temp
|\
* | 80c410e Tree of 00ad8d7 with 7599421 as parent
| | * 4620c9b (feature) E
| |/
| * 317c828 D
|/
* 7599421 C
| * 00ad8d7 (master) B
|/
* 72cc07d A
55a7299
with 00ad8d7
as the only parent and update temp
's reference to point to this new commit.
* 3698031 (HEAD -> temp) D
* 00ad8d7 (master) B
| * 4620c9b (feature) E
| * 317c828 D
| * 7599421 C
|/
* 72cc07d A
4620c9b
on temp
.
* d82c247 (HEAD -> temp) E
* 3698031 D
* 00ad8d7 (master) B
| * 4620c9b (feature) E
| * 317c828 D
| * 7599421 C
|/
* 72cc07d A
master
's reference to the same as temp
with PATCH /repos/:owner/:repo/git/refs/:ref, making sure it's a fast-forward update.
* d82c247 (HEAD -> master, temp) E
* 3698031 D
* 00ad8d7 B
| * 4620c9b (feature) E
| * 317c828 D
| * 7599421 C
|/
* 72cc07d A
temp
branch with DELETE /repos/:owner/:repo/git/refs/:ref and we're done!
* d82c247 (HEAD -> master) E
* 3698031 D
* 00ad8d7 B
| * 4620c9b (feature) E
| * 317c828 D
| * 7599421 C
|/
* 72cc07d A
github-cherry-pick
is atomic.
It will either successfully cherry-pick all the given commits on the specified branch or let the branch untouched if one commit could not be cherry picked or if the branch reference changed while the cherry-picking was happening.
There are tests for it.
FAQs
Cherry-pick several commits on a branch using the low level Git Data operations provided by the GitHub REST API
The npm package github-cherry-pick receives a total of 29,641 weekly downloads. As such, github-cherry-pick popularity was classified as popular.
We found that github-cherry-pick demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.