@intentius/chant 0.124.6 → 0.124.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lifecycle/rollback.d.ts.map +1 -1
- package/dist/op/activities/forge-pull-request.d.ts +49 -0
- package/dist/op/activities/forge-pull-request.d.ts.map +1 -0
- package/dist/op/activities/lexicon-upgrade.d.ts +7 -0
- package/dist/op/activities/lexicon-upgrade.d.ts.map +1 -1
- package/dist/op/activities/propose-upgrade.d.ts +6 -0
- package/dist/op/activities/propose-upgrade.d.ts.map +1 -1
- package/dist/op/activities/reconcile.d.ts.map +1 -1
- package/dist/pr-forge.d.ts +101 -7
- package/dist/pr-forge.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/lifecycle/rollback.ts +10 -2
- package/src/op/activities/forge-pull-request.test.ts +91 -0
- package/src/op/activities/forge-pull-request.ts +98 -0
- package/src/op/activities/lexicon-upgrade.test.ts +58 -0
- package/src/op/activities/lexicon-upgrade.ts +34 -8
- package/src/op/activities/propose-upgrade.ts +13 -0
- package/src/op/activities/reconcile.ts +10 -2
- package/src/pr-forge-bundle.test.ts +1 -1
- package/src/pr-forge.test.ts +212 -0
- package/src/pr-forge.ts +291 -13
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rollback.d.ts","sourceRoot":"","sources":["../../src/lifecycle/rollback.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"rollback.d.ts","sourceRoot":"","sources":["../../src/lifecycle/rollback.ts"],"names":[],"mappings":"AAmBA,2CAA2C;AAC3C,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEpF;AAED,qCAAqC;AACrC,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAE1E;AAED,+EAA+E;AAC/E,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAO5F;AAED,MAAM,WAAW,cAAc;IAC7B,2EAA2E;IAC3E,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,kBAAkB,CAAC,IAAI,EAAE;IAC7C,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,+EAA+E;IAC/E,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,GAAG,OAAO,CAAC,cAAc,CAAC,CA4D1B"}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Where chant's own pull-request paths open their pull request (#3798).
|
|
3
|
+
*
|
|
4
|
+
* `reconcilePr`'s `pull-request` mode, `lexiconUpgrade`, rollback and
|
|
5
|
+
* `proposeWorkspaceUpgrade` open a pull request with `gh pr`. `gh pr create`,
|
|
6
|
+
* `view`, `edit` and `list` speak GitHub's GraphQL API, which Forgejo does not
|
|
7
|
+
* serve, so #3780's `GH_HOST` sends them to the right Forgejo instance only
|
|
8
|
+
* for them to fail there. GitLab has no `gh` at all. On those two forges each
|
|
9
|
+
* path opens, finds and edits its pull request over REST through
|
|
10
|
+
* `../../pr-forge.ts` instead. GitHub, and a run outside any CI job, keep
|
|
11
|
+
* `gh` and the operator's own `gh auth login`.
|
|
12
|
+
*
|
|
13
|
+
* The forge and its token come from the CI job's environment
|
|
14
|
+
* ({@link forgeTargetFromEnv}). The repository is the one the checkout's
|
|
15
|
+
* remote names, when that remote is on the job's forge, so a path working in
|
|
16
|
+
* another checkout than the job's own still opens its pull request there.
|
|
17
|
+
*/
|
|
18
|
+
import { type ForgeFetch, type PrForge, type PullRequest, type PullRequestSpec } from "../../pr-forge.js";
|
|
19
|
+
type Env = Record<string, string | undefined>;
|
|
20
|
+
/** The repository path a git remote URL names: `owner/name`, or `group/sub/name` on GitLab. */
|
|
21
|
+
export declare function remoteRepoPath(url: string | undefined): string | undefined;
|
|
22
|
+
export interface PullRequestForgeOptions {
|
|
23
|
+
/** A checkout whose remote names the repository. Default: the job's repository. */
|
|
24
|
+
cwd?: string;
|
|
25
|
+
/** The remote in `cwd`. Default `origin`. */
|
|
26
|
+
remote?: string;
|
|
27
|
+
fetch?: ForgeFetch;
|
|
28
|
+
/** Reads a remote's URL. Default `git remote get-url`. For tests. */
|
|
29
|
+
remoteUrl?: (cwd: string, remote: string) => Promise<string | undefined>;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* The REST client a pull request is opened through, or undefined when `gh`
|
|
33
|
+
* serves: on GitHub, and outside a CI job. A Forgejo or GitLab job that lacks
|
|
34
|
+
* a token or a repository throws `ForgeEnvironmentError` naming it, where
|
|
35
|
+
* `gh pr` would have failed on GraphQL.
|
|
36
|
+
*/
|
|
37
|
+
export declare function restPullRequestForge(env?: Env, opts?: PullRequestForgeOptions): Promise<PrForge | undefined>;
|
|
38
|
+
/** What {@link upsertPullRequest} did. */
|
|
39
|
+
export interface UpsertedPullRequest {
|
|
40
|
+
action: "opened" | "updated" | "unchanged";
|
|
41
|
+
pr: PullRequest;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Open a pull request for `spec.head`, or bring the open one's title and
|
|
45
|
+
* body in line with `spec`. An open one already current is left alone.
|
|
46
|
+
*/
|
|
47
|
+
export declare function upsertPullRequest(forge: PrForge, spec: PullRequestSpec): Promise<UpsertedPullRequest>;
|
|
48
|
+
export {};
|
|
49
|
+
//# sourceMappingURL=forge-pull-request.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"forge-pull-request.d.ts","sourceRoot":"","sources":["../../../src/op/activities/forge-pull-request.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAIH,OAAO,EAAgD,KAAK,UAAU,EAAE,KAAK,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAKrJ,KAAK,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;AAE9C,+FAA+F;AAC/F,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAe1E;AAED,MAAM,WAAW,uBAAuB;IACtC,mFAAmF;IACnF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,qEAAqE;IACrE,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAC1E;AAUD;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,GAAG,GAAE,GAAiB,EAAE,IAAI,GAAE,uBAA4B,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAUnI;AAED,0CAA0C;AAC1C,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC;IAC3C,EAAE,EAAE,WAAW,CAAC;CACjB;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAM3G"}
|
|
@@ -25,6 +25,7 @@
|
|
|
25
25
|
import type { UpgradeCheckResult, LexiconId, UpstreamPin } from "../../codegen/pinned-upgrade.js";
|
|
26
26
|
import type { RollingUpgradeResult, RollingLexicon } from "../../codegen/rolling-upgrade.js";
|
|
27
27
|
import { bumpPackageJsonVersion } from "../../codegen/version-bump.js";
|
|
28
|
+
import type { PrForge } from "../../pr-forge.js";
|
|
28
29
|
export { bumpPackageJsonVersion };
|
|
29
30
|
/** Finding mode, mirrors ReconcileOp's mode. */
|
|
30
31
|
export type LexiconUpgradeMode = "report" | "issue" | "pull-request";
|
|
@@ -83,6 +84,12 @@ export interface LexiconUpgradeArgs {
|
|
|
83
84
|
* Defaults to bumpPackageJsonVersion.
|
|
84
85
|
*/
|
|
85
86
|
_bumpPackageVersion?: BumpPackageVersionFn;
|
|
87
|
+
/**
|
|
88
|
+
* The REST client the pull request is found, opened and labelled through,
|
|
89
|
+
* or null for `gh`. Default: one on a Forgejo or GitLab job, `gh`
|
|
90
|
+
* elsewhere (#3798). For tests.
|
|
91
|
+
*/
|
|
92
|
+
_forge?: PrForge | null;
|
|
86
93
|
}
|
|
87
94
|
export interface LexiconUpgradeResult {
|
|
88
95
|
lexicon: SupportedLexicon;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lexicon-upgrade.d.ts","sourceRoot":"","sources":["../../../src/op/activities/lexicon-upgrade.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAMH,OAAO,KAAK,EAAE,kBAAkB,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC/F,OAAO,KAAK,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC1F,OAAO,EAAmB,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;
|
|
1
|
+
{"version":3,"file":"lexicon-upgrade.d.ts","sourceRoot":"","sources":["../../../src/op/activities/lexicon-upgrade.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAMH,OAAO,KAAK,EAAE,kBAAkB,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC/F,OAAO,KAAK,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC1F,OAAO,EAAmB,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAGrF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAG9C,OAAO,EAAE,sBAAsB,EAAE,CAAC;AAMlC,gDAAgD;AAChD,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,OAAO,GAAG,cAAc,CAAC;AAErE,+CAA+C;AAC/C,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,cAAc,CAAC;AAE1D,2CAA2C;AAC3C,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,UAAU,CAAC;AAE/C,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,OAAO,EAAE,gBAAgB,CAAC;IAC1B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAC1B;;;;OAIG;IACH,YAAY,CAAC,EAAE,aAAa,CAAC;IAC7B;;;OAGG;IACH,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B;;OAEG;IACH,GAAG,CAAC,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;IAChF;;;OAGG;IACH,mBAAmB,CAAC,EAAE,oBAAoB,CAAC;IAC3C;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,gBAAgB,CAAC;IAC1B,IAAI,EAAE,kBAAkB,CAAC;IACzB,+DAA+D;IAC/D,UAAU,EAAE,OAAO,CAAC;IACpB,mEAAmE;IACnE,SAAS,EAAE,MAAM,CAAC;IAClB,yEAAyE;IACzE,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IAChC,wDAAwD;IACxD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iFAAiF;IACjF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8EAA8E;IAC9E,OAAO,EAAE,MAAM,CAAC;IAChB,6EAA6E;IAC7E,YAAY,EAAE,OAAO,CAAC;CACvB;AAID,4CAA4C;AAC5C,MAAM,MAAM,aAAa,GAAG,CAAC,IAAI,EAAE;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,SAAS,CAAC;IACnB,yDAAyD;IACzD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,KAAK,OAAO,CAAC,kBAAkB,GAAG,kBAAkB,EAAE,CAAC,CAAC;AAEzD,6CAA6C;AAC7C,MAAM,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAEpC;;;;;;;;;;GAUG;AACH,MAAM,MAAM,QAAQ,GAAG,CACrB,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAA;CAAE,KAC/B,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEjD,4IAA4I;AAC5I,MAAM,MAAM,WAAW,GAAG,CACxB,OAAO,EAAE,SAAS,EAClB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,GAAG,CAAC,EAAE,MAAM,KACT;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,eAAe,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;AAIzF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,WAAW,GACjB,MAAM,GAAG,IAAI,CAKf;AAUD,gFAAgF;AAChF,wBAAgB,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,IAAI,cAAc,CAE9E;AAED;;;;GAIG;AACH,wBAAsB,QAAQ,CAC5B,OAAO,EAAE,gBAAgB,EACzB,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,GAC7E,OAAO,CAAC,OAAO,CAAC,CAIlB;AAID;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAIpE;AAID,uDAAuD;AACvD,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,gBAAgB,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAEjF;AAED,+BAA+B;AAC/B,wBAAgB,cAAc,CAC5B,OAAO,EAAE,gBAAgB,EACzB,IAAI,CAAC,EAAE,MAAM,EACb,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,EAClB,GAAG,CAAC,EAAE,MAAM,GACX,MAAM,CAGR;AAID,mEAAmE;AACnE,wBAAgB,mBAAmB,CAAC,IAAI,EAAE;IACxC,OAAO,EAAE,gBAAgB,CAAC;IAC1B,wDAAwD;IACxD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IAChC,YAAY,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACnD,wFAAwF;IACxF,SAAS,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;CACpD,GAAG,MAAM,CAgET;AAUD;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,GAAE,MAAM,OAAO,CAAC,MAAM,CAAC,UAAU,CAAgC,GAAG,QAAQ,CAO5H;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,GAAG,MAAM,CAE3E;AAsHD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA+V5F"}
|
|
@@ -22,6 +22,7 @@
|
|
|
22
22
|
* The workspace code loads on first call, so importing core's activities
|
|
23
23
|
* loads nothing under `workspace/` (#2525 rule 5).
|
|
24
24
|
*/
|
|
25
|
+
import type { PrForge } from "../../pr-forge.js";
|
|
25
26
|
export type ProposeUpgradeMode = "report" | "branch" | "pull-request";
|
|
26
27
|
export interface ProposeWorkspaceUpgradeArgs {
|
|
27
28
|
/** The lineage scope: `"."` (default) or a vendor scope's directory. */
|
|
@@ -43,6 +44,11 @@ export interface ProposeWorkspaceUpgradeArgs {
|
|
|
43
44
|
cwd?: string;
|
|
44
45
|
/** Replaces the git and gh child processes. For tests. */
|
|
45
46
|
_run?: CommandRunner;
|
|
47
|
+
/**
|
|
48
|
+
* The REST client the pull request is opened through, or null for `gh`.
|
|
49
|
+
* Default: one on a Forgejo or GitLab job, `gh` elsewhere (#3798). For tests.
|
|
50
|
+
*/
|
|
51
|
+
_forge?: PrForge | null;
|
|
46
52
|
/** Replaces build and lint in the worktree. For tests. */
|
|
47
53
|
_runChant?: import("../../workspace/lineage-upgrade.js").ChantRunner;
|
|
48
54
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"propose-upgrade.d.ts","sourceRoot":"","sources":["../../../src/op/activities/propose-upgrade.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;
|
|
1
|
+
{"version":3,"file":"propose-upgrade.d.ts","sourceRoot":"","sources":["../../../src/op/activities/propose-upgrade.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAOH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAI9C,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,QAAQ,GAAG,cAAc,CAAC;AAEtE,MAAM,WAAW,2BAA2B;IAC1C,wEAAwE;IACxE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gHAAgH;IAChH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAC1B,mFAAmF;IACnF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,6GAA6G;IAC7G,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8EAA8E;IAC9E,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,0DAA0D;IAC1D,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACxB,0DAA0D;IAC1D,SAAS,CAAC,EAAE,OAAO,iCAAiC,EAAE,WAAW,CAAC;CACnE;AAED,uFAAuF;AACvF,MAAM,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,KAAK,GAAG,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAEhG,MAAM,WAAW,6BAA6B;IAC5C,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,kBAAkB,CAAC;IACzB,2DAA2D;IAC3D,OAAO,EAAE,OAAO,CAAC;IACjB,oDAAoD;IACpD,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAOD,uCAAuC;AACvC,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED,6DAA6D;AAC7D,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEpD;AAiCD,6GAA6G;AAC7G,wBAAsB,uBAAuB,CAAC,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAyFvH"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reconcile.d.ts","sourceRoot":"","sources":["../../../src/op/activities/reconcile.ts"],"names":[],"mappings":"AAGA,OAAO,EAA6D,KAAK,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"reconcile.d.ts","sourceRoot":"","sources":["../../../src/op/activities/reconcile.ts"],"names":[],"mappings":"AAGA,OAAO,EAA6D,KAAK,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAMnH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE5E,wDAAwD;AACxD,MAAM,WAAW,cAAc;IAC7B,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,6EAA6E;IAC7E,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,eAAe;IAC9B,uEAAuE;IACvE,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B,8CAA8C;IAC9C,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,iEAAiE;IACjE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qDAAqD;IACrD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;;;;;;;;;;;;OAiBG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,aAAa,CAAC;IACpB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qFAAqF;IACrF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0FAA0F;IAC1F,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gGAAgG;IAChG,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,gDAAgD;IAChD,OAAO,EAAE,cAAc,EAAE,CAAC;CAC3B;AAED,4EAA4E;AAC5E,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAGvD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,MAAM,CAkB/E;AAMD,wDAAwD;AACxD,MAAM,WAAW,kBAAkB;IACjC,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3D;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAS1D;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAK7E;AAED;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAS1D;AAED,sGAAsG;AACtG,wBAAgB,2BAA2B,IAAI,MAAM,CAWpD;AAeD;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,EACvC,YAAY,CAAC,EAAE,OAAO,GACrB,kBAAkB,GAAG,SAAS,CAOhC;AAED;;;;;;GAMG;AACH,wBAAsB,yBAAyB,CAC7C,GAAG,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAe,GACpD,OAAO,CAAC,kBAAkB,CAAC,CAe7B;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,MAAM,CAEjF;AAED,4EAA4E;AAC5E,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,yEAAyE;IACzE,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,YAAY,GAAG,SAAS,CAMlG;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,EAAE,KAAK,EAAE,YAAY,GAAG,MAAM,CAAC,UAAU,CAE/F;AAED,kFAAkF;AAClF,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAO1E;AAED,uFAAuF;AACvF,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAOxD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,EACvC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,YAAY,EACnB,MAAM,CAAC,EAAE,WAAW,GACnB,iBAAiB,CAcnB;AAiCD;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,MAAM,GAAG,CACnB,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAA;CAAE,KAC/B,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4FG;AACH,wBAAsB,uBAAuB,CAC3C,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,MAAM,CAAC,CAkCjB;AAID;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,0EAA0E;IAC1E,GAAG,EAAE,MAAM,CAAC;IACZ,yFAAyF;IACzF,OAAO,EAAE,MAAM,CAAC;IAChB,4FAA4F;IAC5F,GAAG,EAAE,MAAM,CAAC;IACZ,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GACtC,mBAAmB,GAAG,SAAS,CA2BjC;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,0EAA0E;IAC1E,GAAG,EAAE,MAAM,CAAC;IACZ,iFAAiF;IACjF,OAAO,EAAE,MAAM,CAAC;IAChB,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,wBAAwB,CACtC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GACtC,oBAAoB,GAAG,SAAS,CAgBlC;AAED,gGAAgG;AAChG,MAAM,WAAW,eAAe;IAC9B,iGAAiG;IACjG,MAAM,EAAE,eAAe,GAAG,WAAW,CAAC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,yEAAyE;IACzE,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GACtC,eAAe,GAAG,SAAS,CAQ7B;AAED,mFAAmF;AACnF,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAO5D;AAED,2FAA2F;AAC3F,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAOjE;AAmMD;;;GAGG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,EAAE,CAOlE;AA8CD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,eAAe,CAAC,CA0IvG"}
|
package/dist/pr-forge.d.ts
CHANGED
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
* What chant and the products built on it ask of a forge: keep one comment
|
|
3
3
|
* (a merge request note on GitLab) on a pull request up to date, set a commit
|
|
4
4
|
* status, keep one tracking issue in the repository, list who approved a pull
|
|
5
|
-
* request,
|
|
5
|
+
* request, find the pull request that merged a commit, and open or edit a
|
|
6
|
+
* pull request (a merge request on GitLab) for a branch.
|
|
6
7
|
*
|
|
7
8
|
* The pull-request loop (#3183) uses the note, the status and the review
|
|
8
9
|
* calls. `reconcilePr`'s `comment` and `issue` finding modes post through the
|
|
@@ -21,6 +22,10 @@
|
|
|
21
22
|
* `gitlab:<login>`, or `<forge>@<host>:<login>` off the forge's default host.
|
|
22
23
|
* The apply compares that string with the approval's `resolvedBy`.
|
|
23
24
|
*
|
|
25
|
+
* Opening a pull request goes over REST too (#3798): `gh pr` speaks GitHub's
|
|
26
|
+
* GraphQL, which Forgejo does not serve, so chant's own pull-request paths
|
|
27
|
+
* open theirs through {@link PrForge.openPullRequest} on Forgejo and GitLab.
|
|
28
|
+
*
|
|
24
29
|
* Like `./pr-loop.ts`, this bundles without the TypeScript toolchain (#3421):
|
|
25
30
|
* it imports nothing but `node:fs`, to read a CI job's event payload.
|
|
26
31
|
* `./pr-forge-bundle.test.ts` holds it to that.
|
|
@@ -40,7 +45,13 @@ export type ForgeFetch = (url: string, init: {
|
|
|
40
45
|
export interface ForgeStatus {
|
|
41
46
|
/** The status's name, such as `chant/plan` or `terragucci/plan`. */
|
|
42
47
|
context: string;
|
|
43
|
-
|
|
48
|
+
/**
|
|
49
|
+
* GitLab's own states, plus GitHub's `failure` and `error`. Each forge gets
|
|
50
|
+
* the nearest state it has ({@link statusStateFor}): `running` is `pending`
|
|
51
|
+
* on GitHub and Forgejo, `canceled` is `error` there, and `failure` and
|
|
52
|
+
* `error` are `failed` on GitLab.
|
|
53
|
+
*/
|
|
54
|
+
state: ForgeStatusState;
|
|
44
55
|
/** Cut to what the forge keeps: 140 characters on GitHub and Forgejo, 255 on GitLab. */
|
|
45
56
|
description: string;
|
|
46
57
|
/** The pipeline run, linked from the status. */
|
|
@@ -48,6 +59,12 @@ export interface ForgeStatus {
|
|
|
48
59
|
/** GitLab only: the pipeline the status belongs to. */
|
|
49
60
|
pipelineId?: number;
|
|
50
61
|
}
|
|
62
|
+
/** A commit status's state, as a caller names it. */
|
|
63
|
+
export type ForgeStatusState = "pending" | "running" | "success" | "failed" | "failure" | "canceled" | "error";
|
|
64
|
+
/** Every {@link ForgeStatusState}, for a caller that reads one from its own input. */
|
|
65
|
+
export declare const FORGE_STATUS_STATES: readonly ForgeStatusState[];
|
|
66
|
+
/** The state `kind` is sent for `state`. Forgejo takes GitHub's. */
|
|
67
|
+
export declare function statusStateFor(kind: ForgeKind, state: ForgeStatusState): string;
|
|
51
68
|
/**
|
|
52
69
|
* How a comment or an issue is told to be the caller's own. By default the
|
|
53
70
|
* body starts with the marker, chant's recipe since #2291, and anyone may
|
|
@@ -57,12 +74,15 @@ export interface MarkerMatch {
|
|
|
57
74
|
/** `prefix` (the default): the body starts with the marker. `anywhere`: the body carries it. */
|
|
58
75
|
match?: "prefix" | "anywhere";
|
|
59
76
|
/**
|
|
60
|
-
* Only a comment or issue written by this login
|
|
61
|
-
* GitHub and Forgejo, `author.username` on
|
|
62
|
-
* A merge request's author can write a note
|
|
63
|
-
* product that reads its own notes back names
|
|
77
|
+
* Only a comment or issue written by this login, or by any of these
|
|
78
|
+
* logins, counts: `user.login` on GitHub and Forgejo, `author.username` on
|
|
79
|
+
* GitLab, compared without case. A merge request's author can write a note
|
|
80
|
+
* carrying any marker, so a product that reads its own notes back names
|
|
81
|
+
* its bot here. A list is for a bot whose login the job cannot know in
|
|
82
|
+
* advance, such as `gitea-actions` or `forgejo-actions` on Forgejo (#3834).
|
|
83
|
+
* An empty list matches nobody.
|
|
64
84
|
*/
|
|
65
|
-
author?: string;
|
|
85
|
+
author?: string | readonly string[];
|
|
66
86
|
}
|
|
67
87
|
/** What {@link PrForge.upsertComment} did. */
|
|
68
88
|
export interface CommentResult {
|
|
@@ -136,6 +156,53 @@ export interface IssueResult {
|
|
|
136
156
|
/** When the issue was opened (the forge's `created_at`, ISO 8601), for an issue that exists after the call or was just closed. */
|
|
137
157
|
created?: string;
|
|
138
158
|
}
|
|
159
|
+
/** A pull request (merge request) for {@link PrForge.openPullRequest} to open. */
|
|
160
|
+
export interface PullRequestSpec {
|
|
161
|
+
/** The branch with the change, in the same repository. */
|
|
162
|
+
head: string;
|
|
163
|
+
/** The branch it merges into. Default: the repository's default branch, read from the forge. */
|
|
164
|
+
base?: string;
|
|
165
|
+
title: string;
|
|
166
|
+
body: string;
|
|
167
|
+
/**
|
|
168
|
+
* Open it as a draft: GitHub's `draft`, GitLab's `Draft: ` title prefix,
|
|
169
|
+
* Forgejo's `WIP: ` title prefix (it has no draft field).
|
|
170
|
+
*/
|
|
171
|
+
draft?: boolean;
|
|
172
|
+
}
|
|
173
|
+
/** A pull request (merge request) as the forge answered it. */
|
|
174
|
+
export interface PullRequest {
|
|
175
|
+
/** The pull request's number, or the merge request's iid. */
|
|
176
|
+
number: number;
|
|
177
|
+
url?: string;
|
|
178
|
+
title: string;
|
|
179
|
+
body: string;
|
|
180
|
+
/** Its head (source) branch. */
|
|
181
|
+
head: string;
|
|
182
|
+
/** Its base (target) branch. */
|
|
183
|
+
base?: string;
|
|
184
|
+
}
|
|
185
|
+
/** What {@link PrForge.mergePullRequest} merges, and how. */
|
|
186
|
+
export interface MergeOptions {
|
|
187
|
+
/** The head commit the caller reviewed. The merge happens only while the pull request's head is still this commit. */
|
|
188
|
+
sha: string;
|
|
189
|
+
/** Default `merge`. GitLab has no one-call rebase merge, so `rebase` is refused there. */
|
|
190
|
+
method?: "merge" | "squash" | "rebase";
|
|
191
|
+
/** The merge (squash) commit's title. */
|
|
192
|
+
title?: string;
|
|
193
|
+
/** The merge (squash) commit's message body. */
|
|
194
|
+
message?: string;
|
|
195
|
+
/** Delete the head branch after a merge. A failure to delete does not undo the merge. */
|
|
196
|
+
deleteBranch?: boolean;
|
|
197
|
+
}
|
|
198
|
+
/** The outcome of {@link PrForge.mergePullRequest}. */
|
|
199
|
+
export interface MergeResult {
|
|
200
|
+
merged: boolean;
|
|
201
|
+
/** The commit the merge produced, when the forge says. */
|
|
202
|
+
sha?: string;
|
|
203
|
+
/** Why it was not merged: the head moved, a conflict, a failing check, a required review. */
|
|
204
|
+
reason?: string;
|
|
205
|
+
}
|
|
139
206
|
export interface PrForge {
|
|
140
207
|
kind: ForgeKind;
|
|
141
208
|
/** Lower-cased, such as `github.com`. */
|
|
@@ -198,6 +265,32 @@ export interface PrForge {
|
|
|
198
265
|
approvers(pr: number): Promise<string[]>;
|
|
199
266
|
/** The merged pull request that produced `sha`, or null. */
|
|
200
267
|
pullRequestFor(sha: string): Promise<number | null>;
|
|
268
|
+
/**
|
|
269
|
+
* Open a pull request (a merge request on GitLab) from `head` into `base`,
|
|
270
|
+
* or into the default branch when `base` is not given. Over REST on every
|
|
271
|
+
* forge, so it works on Forgejo, where `gh pr create` cannot (#3798).
|
|
272
|
+
*/
|
|
273
|
+
openPullRequest(spec: PullRequestSpec): Promise<PullRequest>;
|
|
274
|
+
/**
|
|
275
|
+
* The OPEN pull request whose head is branch `head` in this repository (a
|
|
276
|
+
* fork's branch of the same name is not it), or undefined. The oldest when
|
|
277
|
+
* there are several.
|
|
278
|
+
*/
|
|
279
|
+
findPullRequest(head: string): Promise<PullRequest | undefined>;
|
|
280
|
+
/** Change an open pull request's title or body. */
|
|
281
|
+
editPullRequest(pr: number, change: {
|
|
282
|
+
title?: string;
|
|
283
|
+
body?: string;
|
|
284
|
+
}): Promise<PullRequest | undefined>;
|
|
285
|
+
/** Add labels to a pull request by name. Forgejo needs them to exist; GitHub and GitLab make them. */
|
|
286
|
+
addLabels(pr: number, labels: readonly string[]): Promise<void>;
|
|
287
|
+
/**
|
|
288
|
+
* Merge pull request `pr` only if its head is still `opts.sha`. A moved
|
|
289
|
+
* head, a conflict or a branch rule the forge enforces comes back as
|
|
290
|
+
* `{ merged: false, reason }`; auth, missing-pull-request and server errors
|
|
291
|
+
* still throw.
|
|
292
|
+
*/
|
|
293
|
+
mergePullRequest(pr: number, opts: MergeOptions): Promise<MergeResult>;
|
|
201
294
|
}
|
|
202
295
|
/** A GitHub or Forgejo client. */
|
|
203
296
|
export type GithubShapedForge = PrForge & {
|
|
@@ -208,6 +301,7 @@ export declare class ForgeApiError extends Error {
|
|
|
208
301
|
readonly method: string;
|
|
209
302
|
readonly url: string;
|
|
210
303
|
readonly status: number;
|
|
304
|
+
readonly detail: string;
|
|
211
305
|
constructor(method: string, url: string, status: number, detail: string);
|
|
212
306
|
}
|
|
213
307
|
/** `<forge>:<login>` on the forge's default host, `<forge>@<host>:<login>` elsewhere, lower-cased (#3163's form). */
|
package/dist/pr-forge.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pr-forge.d.ts","sourceRoot":"","sources":["../src/pr-forge.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"pr-forge.d.ts","sourceRoot":"","sources":["../src/pr-forge.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAIH,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;AAExD,eAAO,MAAM,WAAW,EAAE,SAAS,SAAS,EAAoC,CAAC;AAEjF,wDAAwD;AACxD,MAAM,MAAM,UAAU,GAAG,CACvB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,KACrE,OAAO,CAAC;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;CAAE,CAAC,CAAC;AAEvE,MAAM,WAAW,WAAW;IAC1B,oEAAoE;IACpE,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,KAAK,EAAE,gBAAgB,CAAC;IACxB,wFAAwF;IACxF,WAAW,EAAE,MAAM,CAAC;IACpB,gDAAgD;IAChD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,qDAAqD;AACrD,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,OAAO,CAAC;AAE/G,sFAAsF;AACtF,eAAO,MAAM,mBAAmB,EAAE,SAAS,gBAAgB,EAAgF,CAAC;AAa5I,oEAAoE;AACpE,wBAAgB,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,gBAAgB,GAAG,MAAM,CAI/E;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,gGAAgG;IAChG,KAAK,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;IAC9B;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC;CACrC;AAED,8CAA8C;AAC9C,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,CAAC;IAC5C,kCAAkC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,wGAAwG;IACxG,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,+DAA+D;AAC/D,MAAM,WAAW,YAAY;IAC3B,kCAAkC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,wGAAwG;IACxG,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,8CAA8C;AAC9C,MAAM,WAAW,YAAY;IAC3B,sCAAsC;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,wGAAwG;IACxG,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,kEAAkE;AAClE,MAAM,WAAW,UAAU;IACzB,4DAA4D;IAC5D,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,+EAA+E;IAC/E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,wEAAwE;AACxE,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,+CAA+C;IAC/C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,YAAY,KAAK,OAAO,CAAC,CAAC;CAC9E;AAED,2CAA2C;AAC3C,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;IACxE,4DAA4D;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kIAAkI;IAClI,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,kFAAkF;AAClF,MAAM,WAAW,eAAe;IAC9B,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,gGAAgG;IAChG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,+DAA+D;AAC/D,MAAM,WAAW,WAAW;IAC1B,6DAA6D;IAC7D,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,6DAA6D;AAC7D,MAAM,WAAW,YAAY;IAC3B,sHAAsH;IACtH,GAAG,EAAE,MAAM,CAAC;IACZ,0FAA0F;IAC1F,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACvC,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yFAAyF;IACzF,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,uDAAuD;AACvD,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,OAAO,CAAC;IAChB,0DAA0D;IAC1D,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,6FAA6F;IAC7F,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAqBD,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,SAAS,CAAC;IAChB,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,6EAA6E;IAC7E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6CAA6C;IAC7C,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACnC;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACpG;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAClF;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;IAC/F;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC5D,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3D;;;;;;OAMG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI,EAAE,IAAI,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACzG;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAC/E;;;OAGG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IACtF,kDAAkD;IAClD,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACzC,4DAA4D;IAC5D,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACpD;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7D;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC;IAChE,mDAAmD;IACnD,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC;IACzG,sGAAsG;IACtG,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CACxE;AAED,kCAAkC;AAClC,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG;IAAE,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAA;CAAE,CAAC;AAEzE,+DAA+D;AAC/D,qBAAa,aAAc,SAAQ,KAAK;IAEpC,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,QAAQ,CAAC,GAAG,EAAE,MAAM;IACpB,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM;IAJzB,YACW,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EAIxB;CACF;AAID,qHAAqH;AACrH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAIrF;AAwJD,MAAM,WAAW,kBAAkB;IACjC,kGAAkG;IAClG,OAAO,EAAE,MAAM,CAAC;IAChB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,uIAAuI;IACvI,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kEAAkE;IAClE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB;AA8LD,gEAAgE;AAChE,wBAAgB,WAAW,CAAC,IAAI,EAAE,kBAAkB,GAAG,iBAAiB,CAEvE;AAED,oFAAoF;AACpF,wBAAgB,YAAY,CAAC,IAAI,EAAE,kBAAkB,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,iBAAiB,CAE3F;AAED,MAAM,WAAW,kBAAkB;IACjC,wBAAwB;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,OAAO,EAAE,MAAM,CAAC;IAChB,oIAAoI;IACpI,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,WAAW,CAAC,EAAE,eAAe,GAAG,WAAW,CAAC;IAC5C,0BAA0B;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAsI7D;AAED,mEAAmE;AACnE,qBAAa,qBAAsB,SAAQ,KAAK;IAM5C,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS;IACpC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE;IAN5B;;;OAGG;IACH,YACW,IAAI,EAAE,SAAS,GAAG,SAAS,EAC3B,OAAO,EAAE,MAAM,EAAE,EAQ3B;CACF;AAWD;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAe,EAAE,SAAS,CAAC,EAAE,UAAU,GAAG,OAAO,CAwCpI;AAID,KAAK,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;AAI9C;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,GAAE,GAAiB,GAAG,SAAS,GAAG,SAAS,CAKzE;AAED,uHAAuH;AACvH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,qGAAqG;IACrG,OAAO,EAAE,MAAM,CAAC;IAChB,4EAA4E;IAC5E,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,8EAA8E;IAC9E,WAAW,EAAE,MAAM,CAAC;IACpB,kFAAkF;IAClF,WAAW,CAAC,EAAE,eAAe,GAAG,WAAW,CAAC;IAC5C,6DAA6D;IAC7D,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,uFAAuF;IACvF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,kDAAkD;IAClD,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;CACrC;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAIlE,CAAC;AAoBF;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,GAAE,GAAiB,EAAE,IAAI,GAAE,kBAAuB,GAAG,WAAW,CAuErG;AAED,8FAA8F;AAC9F,wBAAgB,WAAW,CAAC,MAAM,EAAE,WAAW,EAAE,SAAS,CAAC,EAAE,UAAU,GAAG,OAAO,CAgBhF"}
|
package/package.json
CHANGED
|
@@ -13,6 +13,7 @@ import { promisify } from "node:util";
|
|
|
13
13
|
import { tmpdir } from "node:os";
|
|
14
14
|
import { join } from "node:path";
|
|
15
15
|
import { ghHostEnv } from "../op/activities/gh-host";
|
|
16
|
+
import { restPullRequestForge } from "../op/activities/forge-pull-request";
|
|
16
17
|
|
|
17
18
|
const execFileAsync = promisify(execFile);
|
|
18
19
|
|
|
@@ -107,9 +108,16 @@ export async function rollbackToRevision(opts: {
|
|
|
107
108
|
|
|
108
109
|
await git(["commit", "-m", rollbackTitle(env, ref)], wt);
|
|
109
110
|
await git(["push", "-u", "origin", branch], wt);
|
|
111
|
+
// `gh pr` speaks GraphQL, which Forgejo does not serve: a Forgejo or
|
|
112
|
+
// GitLab job opens the pull request over REST (#3798).
|
|
113
|
+
const forge = await restPullRequestForge(process.env, { cwd: wt });
|
|
114
|
+
if (forge) {
|
|
115
|
+
const pr = await forge.openPullRequest({ head: branch, title: rollbackTitle(env, ref), body: rollbackBody(env, ref, sourceDir) });
|
|
116
|
+
return { noop: false, branch, prUrl: pr.url ?? "" };
|
|
117
|
+
}
|
|
110
118
|
// `gh pr create` names no host: tell it the one `origin` is on, or the
|
|
111
|
-
// CI job's forge, so a GitHub Enterprise Server
|
|
112
|
-
//
|
|
119
|
+
// CI job's forge, so a GitHub Enterprise Server checkout is not sent to
|
|
120
|
+
// github.com (#3780).
|
|
113
121
|
const { stdout } = await execFileAsync(
|
|
114
122
|
"gh",
|
|
115
123
|
["pr", "create", "--title", rollbackTitle(env, ref), "--body", rollbackBody(env, ref, sourceDir), "--head", branch],
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Which pull-request paths go over REST (#3798): a Forgejo or GitLab job
|
|
3
|
+
* does, GitHub and a local run keep `gh`. Driven with an injected fetch.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
import { describe, expect, test } from "vitest";
|
|
7
|
+
import { ForgeEnvironmentError, type ForgeFetch } from "../../pr-forge";
|
|
8
|
+
import { remoteRepoPath, restPullRequestForge, upsertPullRequest } from "./forge-pull-request";
|
|
9
|
+
|
|
10
|
+
interface Call {
|
|
11
|
+
method: string;
|
|
12
|
+
url: string;
|
|
13
|
+
body?: unknown;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
function fakeFetch(routes: Record<string, unknown>): { fetch: ForgeFetch; calls: Call[] } {
|
|
17
|
+
const calls: Call[] = [];
|
|
18
|
+
const fetch: ForgeFetch = async (url, init) => {
|
|
19
|
+
calls.push({ method: init.method, url, ...(init.body ? { body: JSON.parse(init.body) } : {}) });
|
|
20
|
+
const found = routes[`${init.method} ${new URL(url).pathname}`];
|
|
21
|
+
if (found === undefined) return { ok: false, status: 404, text: async () => "" };
|
|
22
|
+
return { ok: true, status: 200, text: async () => JSON.stringify(found) };
|
|
23
|
+
};
|
|
24
|
+
return { fetch, calls };
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
const FORGEJO_JOB = {
|
|
28
|
+
FORGEJO_ACTIONS: "true",
|
|
29
|
+
GITHUB_SERVER_URL: "https://forge.example",
|
|
30
|
+
GITHUB_API_URL: "https://forge.example/api/v1",
|
|
31
|
+
GITHUB_REPOSITORY: "acme/infra",
|
|
32
|
+
GITHUB_TOKEN: "tok",
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
describe("remoteRepoPath", () => {
|
|
36
|
+
test("reads owner/name off https, ssh and scp-style remotes", () => {
|
|
37
|
+
expect(remoteRepoPath("https://forge.example/acme/infra.git")).toBe("acme/infra");
|
|
38
|
+
expect(remoteRepoPath("ssh://git@forge.example:2222/acme/infra.git")).toBe("acme/infra");
|
|
39
|
+
expect(remoteRepoPath("git@gitlab.com:group/sub/infra.git")).toBe("group/sub/infra");
|
|
40
|
+
expect(remoteRepoPath("https://forge.example/")).toBeUndefined();
|
|
41
|
+
expect(remoteRepoPath(undefined)).toBeUndefined();
|
|
42
|
+
});
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
describe("restPullRequestForge", () => {
|
|
46
|
+
test("GitHub and a run outside CI keep gh", async () => {
|
|
47
|
+
expect(await restPullRequestForge({ GITHUB_ACTIONS: "true", GITHUB_REPOSITORY: "acme/infra", GITHUB_TOKEN: "t" })).toBeUndefined();
|
|
48
|
+
expect(await restPullRequestForge({})).toBeUndefined();
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
test("a Forgejo job opens over REST, on the repository the checkout's remote names", async () => {
|
|
52
|
+
const { fetch, calls } = fakeFetch({ "POST /api/v1/repos/acme/other/pulls": { number: 3, html_url: "https://forge.example/acme/other/pulls/3" } });
|
|
53
|
+
const forge = await restPullRequestForge(FORGEJO_JOB, { cwd: "/wt", fetch, remoteUrl: async () => "https://forge.example/acme/other.git" });
|
|
54
|
+
expect(forge?.kind).toBe("forgejo");
|
|
55
|
+
expect((await forge!.openPullRequest({ head: "h", base: "main", title: "t", body: "b" })).url).toBe("https://forge.example/acme/other/pulls/3");
|
|
56
|
+
expect(calls[0].url).toBe("https://forge.example/api/v1/repos/acme/other/pulls");
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
test("a remote on another host leaves the job's repository", async () => {
|
|
60
|
+
const { fetch, calls } = fakeFetch({ "POST /api/v1/repos/acme/infra/pulls": { number: 1 } });
|
|
61
|
+
const forge = await restPullRequestForge(FORGEJO_JOB, { cwd: "/wt", fetch, remoteUrl: async () => "https://github.com/acme/mirror.git" });
|
|
62
|
+
await forge!.openPullRequest({ head: "h", base: "main", title: "t", body: "b" });
|
|
63
|
+
expect(calls[0].url).toBe("https://forge.example/api/v1/repos/acme/infra/pulls");
|
|
64
|
+
});
|
|
65
|
+
|
|
66
|
+
test("a GitLab job opens a merge request; a Forgejo job with no token is refused by name", async () => {
|
|
67
|
+
const forge = await restPullRequestForge({ GITLAB_CI: "true", CI_API_V4_URL: "https://gl/api/v4", CI_PROJECT_ID: "42", GITLAB_TOKEN: "t" });
|
|
68
|
+
expect(forge?.kind).toBe("gitlab");
|
|
69
|
+
const { GITHUB_TOKEN: _, ...noToken } = FORGEJO_JOB;
|
|
70
|
+
await expect(restPullRequestForge(noToken)).rejects.toBeInstanceOf(ForgeEnvironmentError);
|
|
71
|
+
});
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
describe("upsertPullRequest", () => {
|
|
75
|
+
const open = { number: 10, title: "t", body: "b", head: { ref: "h", repo: { full_name: "acme/infra" } }, html_url: "https://forge.example/acme/infra/pulls/10" };
|
|
76
|
+
|
|
77
|
+
test("opens one when none is open, edits the open one, leaves a current one alone", async () => {
|
|
78
|
+
const env = FORGEJO_JOB;
|
|
79
|
+
const none = fakeFetch({ "GET /api/v1/repos/acme/infra/pulls": [], "POST /api/v1/repos/acme/infra/pulls": { number: 11 } });
|
|
80
|
+
expect((await upsertPullRequest((await restPullRequestForge(env, { fetch: none.fetch }))!, { head: "h", base: "main", title: "t", body: "b" })).action).toBe("opened");
|
|
81
|
+
|
|
82
|
+
const stale = fakeFetch({ "GET /api/v1/repos/acme/infra/pulls": [open], "PATCH /api/v1/repos/acme/infra/pulls/10": { ...open, title: "t2" } });
|
|
83
|
+
const r = await upsertPullRequest((await restPullRequestForge(env, { fetch: stale.fetch }))!, { head: "h", base: "main", title: "t2", body: "b" });
|
|
84
|
+
expect(r).toMatchObject({ action: "updated", pr: { number: 10, title: "t2", url: open.html_url } });
|
|
85
|
+
expect(stale.calls.at(-1)).toMatchObject({ method: "PATCH", body: { title: "t2", body: "b" } });
|
|
86
|
+
|
|
87
|
+
const current = fakeFetch({ "GET /api/v1/repos/acme/infra/pulls": [open] });
|
|
88
|
+
expect((await upsertPullRequest((await restPullRequestForge(env, { fetch: current.fetch }))!, { head: "h", title: "t", body: "b\n" })).action).toBe("unchanged");
|
|
89
|
+
expect(current.calls.every((c) => c.method === "GET")).toBe(true);
|
|
90
|
+
});
|
|
91
|
+
});
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Where chant's own pull-request paths open their pull request (#3798).
|
|
3
|
+
*
|
|
4
|
+
* `reconcilePr`'s `pull-request` mode, `lexiconUpgrade`, rollback and
|
|
5
|
+
* `proposeWorkspaceUpgrade` open a pull request with `gh pr`. `gh pr create`,
|
|
6
|
+
* `view`, `edit` and `list` speak GitHub's GraphQL API, which Forgejo does not
|
|
7
|
+
* serve, so #3780's `GH_HOST` sends them to the right Forgejo instance only
|
|
8
|
+
* for them to fail there. GitLab has no `gh` at all. On those two forges each
|
|
9
|
+
* path opens, finds and edits its pull request over REST through
|
|
10
|
+
* `../../pr-forge.ts` instead. GitHub, and a run outside any CI job, keep
|
|
11
|
+
* `gh` and the operator's own `gh auth login`.
|
|
12
|
+
*
|
|
13
|
+
* The forge and its token come from the CI job's environment
|
|
14
|
+
* ({@link forgeTargetFromEnv}). The repository is the one the checkout's
|
|
15
|
+
* remote names, when that remote is on the job's forge, so a path working in
|
|
16
|
+
* another checkout than the job's own still opens its pull request there.
|
|
17
|
+
*/
|
|
18
|
+
|
|
19
|
+
import { execFile } from "node:child_process";
|
|
20
|
+
import { promisify } from "node:util";
|
|
21
|
+
import { detectForge, forgeClient, forgeTargetFromEnv, type ForgeFetch, type PrForge, type PullRequest, type PullRequestSpec } from "../../pr-forge";
|
|
22
|
+
import { remoteHost } from "./gh-host";
|
|
23
|
+
|
|
24
|
+
const execFileAsync = promisify(execFile);
|
|
25
|
+
|
|
26
|
+
type Env = Record<string, string | undefined>;
|
|
27
|
+
|
|
28
|
+
/** The repository path a git remote URL names: `owner/name`, or `group/sub/name` on GitLab. */
|
|
29
|
+
export function remoteRepoPath(url: string | undefined): string | undefined {
|
|
30
|
+
const u = url?.trim();
|
|
31
|
+
if (!u) return undefined;
|
|
32
|
+
const scp = /^[^@/\s]+@[^:/\s]+:(?!\/)(.+)$/.exec(u);
|
|
33
|
+
let path: string;
|
|
34
|
+
if (scp) path = scp[1]!;
|
|
35
|
+
else {
|
|
36
|
+
try {
|
|
37
|
+
path = new URL(u).pathname;
|
|
38
|
+
} catch {
|
|
39
|
+
return undefined;
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
const out = path.replace(/^\/+/, "").replace(/\/+$/, "").replace(/\.git$/, "");
|
|
43
|
+
return out.includes("/") ? out : undefined;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export interface PullRequestForgeOptions {
|
|
47
|
+
/** A checkout whose remote names the repository. Default: the job's repository. */
|
|
48
|
+
cwd?: string;
|
|
49
|
+
/** The remote in `cwd`. Default `origin`. */
|
|
50
|
+
remote?: string;
|
|
51
|
+
fetch?: ForgeFetch;
|
|
52
|
+
/** Reads a remote's URL. Default `git remote get-url`. For tests. */
|
|
53
|
+
remoteUrl?: (cwd: string, remote: string) => Promise<string | undefined>;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
const gitRemoteUrl = async (cwd: string, remote: string): Promise<string | undefined> => {
|
|
57
|
+
try {
|
|
58
|
+
return (await execFileAsync("git", ["remote", "get-url", remote], { cwd })).stdout.trim();
|
|
59
|
+
} catch {
|
|
60
|
+
return undefined;
|
|
61
|
+
}
|
|
62
|
+
};
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* The REST client a pull request is opened through, or undefined when `gh`
|
|
66
|
+
* serves: on GitHub, and outside a CI job. A Forgejo or GitLab job that lacks
|
|
67
|
+
* a token or a repository throws `ForgeEnvironmentError` naming it, where
|
|
68
|
+
* `gh pr` would have failed on GraphQL.
|
|
69
|
+
*/
|
|
70
|
+
export async function restPullRequestForge(env: Env = process.env, opts: PullRequestForgeOptions = {}): Promise<PrForge | undefined> {
|
|
71
|
+
const kind = detectForge(env);
|
|
72
|
+
if (kind !== "forgejo" && kind !== "gitlab") return undefined;
|
|
73
|
+
const target = forgeTargetFromEnv(env, { kind });
|
|
74
|
+
if (opts.cwd) {
|
|
75
|
+
const url = await (opts.remoteUrl ?? gitRemoteUrl)(opts.cwd, opts.remote ?? "origin");
|
|
76
|
+
const path = remoteRepoPath(url);
|
|
77
|
+
if (path && remoteHost(url) === target.host) target.repo = path;
|
|
78
|
+
}
|
|
79
|
+
return forgeClient(target, opts.fetch);
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
/** What {@link upsertPullRequest} did. */
|
|
83
|
+
export interface UpsertedPullRequest {
|
|
84
|
+
action: "opened" | "updated" | "unchanged";
|
|
85
|
+
pr: PullRequest;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
/**
|
|
89
|
+
* Open a pull request for `spec.head`, or bring the open one's title and
|
|
90
|
+
* body in line with `spec`. An open one already current is left alone.
|
|
91
|
+
*/
|
|
92
|
+
export async function upsertPullRequest(forge: PrForge, spec: PullRequestSpec): Promise<UpsertedPullRequest> {
|
|
93
|
+
const open = await forge.findPullRequest(spec.head);
|
|
94
|
+
if (!open) return { action: "opened", pr: await forge.openPullRequest(spec) };
|
|
95
|
+
if (open.title === spec.title && open.body.trim() === spec.body.trim()) return { action: "unchanged", pr: open };
|
|
96
|
+
const edited = await forge.editPullRequest(open.number, { title: spec.title, body: spec.body });
|
|
97
|
+
return { action: "updated", pr: edited ?? { ...open, title: spec.title, body: spec.body } };
|
|
98
|
+
}
|