backport
Version:
A CLI tool that automates the process of backporting commits
218 lines (213 loc) ā¢ 14.1 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
const packageVersionModule = __importStar(require("../../../utils/packageVersion"));
const childProcessHelper_1 = require("../../childProcessHelper");
const getDevAccessToken_1 = require("../../private/getDevAccessToken");
const sandbox_1 = require("../../sandbox");
const runBackportViaCli_1 = require("./runBackportViaCli");
jest.setTimeout(15000);
const accessToken = (0, getDevAccessToken_1.getDevAccessToken)();
describe('entrypoint cli', () => {
it('--version', async () => {
const { output } = await (0, runBackportViaCli_1.runBackportViaCli)([`--version`], {
showOra: true,
});
expect(output).toEqual(process.env.npm_package_version);
});
it('-v', async () => {
const { output } = await (0, runBackportViaCli_1.runBackportViaCli)([`-v`], {
showOra: true,
});
expect(output).toEqual(process.env.npm_package_version);
});
it('PACKAGE_VERSION should match', async () => {
// @ts-expect-error
expect(packageVersionModule.UNMOCKED_PACKAGE_VERSION).toBe(process.env.npm_package_version);
});
it('--help', async () => {
const { output } = await (0, runBackportViaCli_1.runBackportViaCli)([`--help`, '--noExitProcess'], {
waitForString: 'Or contact me directly',
});
const [help] = output.split('https://twitter.com/sorenlouv');
expect(help).toMatchInlineSnapshot(`
"entrypoint.cli.ts [args]
Options:
-v, --version Show version number [boolean]
--accessToken, --accesstoken Github access token [string]
-a, --all List all commits [boolean]
--assignee, --assign Add assignees to the target pull request
[array]
--autoAssign Auto assign the target pull request to
yourself [boolean]
--autoMerge Enable auto-merge for created pull requests
[boolean]
--autoMergeMethod Sets auto-merge method when using
--auto-merge. Default: merge
[string] [choices: "merge", "rebase", "squash"]
--cherrypickRef Append commit message with "(cherry picked
from commit...) [boolean]
--commitConflicts Commit conflicts instead of aborting. Only
takes effect in \`non-interactive\` mode.
Defaults to false [boolean]
--projectConfigFile, --config Path to project config [string]
--globalConfigFile Path to global config [string]
--dateSince, --since ISO-8601 date for filtering commits [string]
--dateUntil, --until ISO-8601 date for filtering commits [string]
--dir Path to temporary backport repo [string]
--details Show details about each commit [boolean]
--draft Publish pull request as draft [boolean]
--dryRun Run backport locally without pushing to Github
[boolean]
--editor Editor to be opened during conflict resolution
[string]
--skipRemoteConfig Use local .backportrc.json config instead of
loading from Github [boolean]
--fork Create backports in fork or origin repo.
Defaults to true [boolean]
--gitAuthorName Set commit author name [string]
--gitAuthorEmail Set commit author email [string]
--nonInteractive, --json Disable interactive prompts and return
response as JSON [boolean]
--ls List commits instead of backporting them
[boolean]
--mainline Parent id of merge commit. Defaults to 1 when
supplied without arguments [number]
-s, --signoff Pass the --signoff option to the cherry-pick
command [boolean]
-n, --maxNumber, --number Number of commits to choose from [number]
--multiple Select multiple branches/commits [boolean]
--multipleBranches Backport to multiple branches [boolean]
--multipleCommits Backport multiple commits [boolean]
--noCherrypickRef Do not append commit message with "(cherry
picked from commit...)" [boolean]
--noStatusComment Don't publish status comment to Github
[boolean]
--noVerify Bypass the pre-commit and commit-msg hooks
[boolean]
--noFork Create backports in the origin repo [boolean]
--noTelemetry Disable telemetry [boolean]
--onlyMissing Only list commits with missing or unmerged
backports [boolean]
-p, --path Only list commits touching files under the
specified path [array]
--prDescription, --description Description to be added to pull request
[string]
--prTitle, --title Title of pull request [string]
--prFilter Filter source pull requests by a query[string]
--pullNumber, --pr Pull request to backport [number]
--resetAuthor Set yourself as commit author [boolean]
--reviewer Add reviewer to the target PR [array]
--repoForkOwner The owner of the fork where the backport
branch is pushed. Defaults to the currently
authenticated user [string]
--repo, --upstream Repo owner and name [string]
--sha, --commit Commit sha to backport [string]
--noUnmergedBackportsHelp Do not list the unmerged backports in PR
comment [boolean]
--sourceBranch Specify a non-default branch (normally
"master") to backport from [string]
--sourcePRLabel, --sourcePrLabel Add labels to the source (original) PR [array]
--copySourcePRLabels, --copySourcePrLabels Copy labels from source PR to the target PR
[boolean]
--copySourcePRReviewers, Copy reviewers from the source PR to the
--copySourcePrReviewers, target PR
--addOriginalReviewers [boolean]
-b, --targetBranch, --branch Branch(es) to backport to [array]
--targetBranchChoice List branches to backport to [array]
-l, --targetPRLabel, --label Add labels to the target (backport) PR [array]
--backportBranchName Name template to use for the branch name of
the backport [string]
--verify Opposite of no-verify [boolean]
--help Show help [boolean]
For bugs, feature requests or questions: https://github.com/sorenlouv/backport/issues
Or contact me directly: "
`);
});
it('lists commits based on .git/config when `repoOwner`/`repoName` is missing', async () => {
const sandboxPath = (0, sandbox_1.getSandboxPath)({ filename: __filename });
await (0, sandbox_1.resetSandbox)(sandboxPath);
await (0, childProcessHelper_1.exec)(`git init`, { cwd: sandboxPath });
await (0, childProcessHelper_1.exec)(`git remote add origin git@github.com:backport-org/backport-e2e.git`, { cwd: sandboxPath });
const { output } = await (0, runBackportViaCli_1.runBackportViaCli)([`--accessToken=${accessToken}`], {
cwd: sandboxPath,
waitForString: 'Select commit',
});
expect(output).toMatchInlineSnapshot(`
"repo: backport-org/backport-e2e š¹ sourceBranch: master š¹ author: sorenlouv
? Select commit (Use arrow keys)
āÆ 1. Add sheep emoji (#9) 7.8
2. Change Ulysses to Gretha (conflict) (#8) 7.x
3. Add š emoji (#5) 7.8, 7.x
4. Add family emoji (#2) 7.x
5. Add \`backport\` dep
6. Merge pull request #1 from backport-org/add-heart-emoji
7. Add ā¤ļø emoji
8. Update .backportrc.json
9. Bump to 8.0.0
10.Add package.json"
`);
});
it(`lists commits from master`, async () => {
const { output } = await (0, runBackportViaCli_1.runBackportViaCli)([
'--branch=7.x',
'--repo=backport-org/backport-e2e',
'--author=sorenlouv',
`--accessToken=${accessToken}`,
'--max-number=6',
], { waitForString: 'Select commit' });
expect(output).toMatchInlineSnapshot(`
"repo: backport-org/backport-e2e š¹ sourceBranch: master š¹ author: sorenlouv š¹ maxNumber: 6
? Select commit (Use arrow keys)
āÆ 1. Add sheep emoji (#9) 7.8
2. Change Ulysses to Gretha (conflict) (#8) 7.x
3. Add š emoji (#5) 7.8, 7.x
4. Add family emoji (#2) 7.x
5. Add \`backport\` dep
6. Merge pull request #1 from backport-org/add-heart-emoji"
`);
});
it(`lists commits from 7.x`, async () => {
const { output } = await (0, runBackportViaCli_1.runBackportViaCli)([
'--branch=7.x',
'--repo=backport-org/backport-e2e',
'--author=sorenlouv',
`--accessToken=${accessToken}`,
'--max-number=6',
'--source-branch=7.x',
], { waitForString: 'Select commit' });
expect(output).toMatchInlineSnapshot(`
"repo: backport-org/backport-e2e š¹ sourceBranch: 7.x š¹ author: sorenlouv š¹ maxNumber: 6
? Select commit (Use arrow keys)
āÆ 1. Add š emoji (#5) (#6)
2. Change Ulysses to Carol
3. Add family emoji (#2) (#4)
4. Update .backportrc.json
5. Branch off: 7.9.0 (7.x)
6. Bump to 8.0.0"
`);
});
});
//# sourceMappingURL=entrypoint.cli.private.test.js.map