@simplysf/simply-cicd-core 0.2.0
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/LICENSE.txt +206 -0
- package/README.md +64 -0
- package/lib/alm/gitlabIssues.d.ts +11 -0
- package/lib/alm/gitlabIssues.js +54 -0
- package/lib/alm/gitlabIssues.js.map +1 -0
- package/lib/alm/index.d.ts +4 -0
- package/lib/alm/index.js +24 -0
- package/lib/alm/index.js.map +1 -0
- package/lib/alm/jira.d.ts +8 -0
- package/lib/alm/jira.js +43 -0
- package/lib/alm/jira.js.map +1 -0
- package/lib/alm/registry.d.ts +10 -0
- package/lib/alm/registry.js +37 -0
- package/lib/alm/registry.js.map +1 -0
- package/lib/alm/types.d.ts +35 -0
- package/lib/alm/types.js +17 -0
- package/lib/alm/types.js.map +1 -0
- package/lib/index.d.ts +2 -0
- package/lib/index.js +27 -0
- package/lib/index.js.map +1 -0
- package/lib/vcs/github.d.ts +28 -0
- package/lib/vcs/github.js +267 -0
- package/lib/vcs/github.js.map +1 -0
- package/lib/vcs/gitlab.d.ts +30 -0
- package/lib/vcs/gitlab.js +242 -0
- package/lib/vcs/gitlab.js.map +1 -0
- package/lib/vcs/index.d.ts +4 -0
- package/lib/vcs/index.js +24 -0
- package/lib/vcs/index.js.map +1 -0
- package/lib/vcs/registry.d.ts +10 -0
- package/lib/vcs/registry.js +37 -0
- package/lib/vcs/registry.js.map +1 -0
- package/lib/vcs/types.d.ts +136 -0
- package/lib/vcs/types.js +17 -0
- package/lib/vcs/types.js.map +1 -0
- package/package.json +130 -0
package/LICENSE.txt
ADDED
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
Apache License Version 2.0
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026, Clay Chipps.
|
|
4
|
+
All rights reserved.
|
|
5
|
+
|
|
6
|
+
Apache License
|
|
7
|
+
Version 2.0, January 2004
|
|
8
|
+
http://www.apache.org/licenses/
|
|
9
|
+
|
|
10
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
11
|
+
|
|
12
|
+
1. Definitions.
|
|
13
|
+
|
|
14
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
15
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
16
|
+
|
|
17
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
18
|
+
the copyright owner that is granting the License.
|
|
19
|
+
|
|
20
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
21
|
+
other entities that control, are controlled by, or are under common
|
|
22
|
+
control with that entity. For the purposes of this definition,
|
|
23
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
24
|
+
direction or management of such entity, whether by contract or
|
|
25
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
26
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
27
|
+
|
|
28
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
29
|
+
exercising permissions granted by this License.
|
|
30
|
+
|
|
31
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
32
|
+
including but not limited to software source code, documentation
|
|
33
|
+
source, and configuration files.
|
|
34
|
+
|
|
35
|
+
"Object" form shall mean any form resulting from mechanical
|
|
36
|
+
transformation or translation of a Source form, including but
|
|
37
|
+
not limited to compiled object code, generated documentation,
|
|
38
|
+
and conversions to other media types.
|
|
39
|
+
|
|
40
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
41
|
+
Object form, made available under the License, as indicated by a
|
|
42
|
+
copyright notice that is included in or attached to the work
|
|
43
|
+
(an example is provided in the Appendix below).
|
|
44
|
+
|
|
45
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
46
|
+
form, that is based on (or derived from) the Work and for which the
|
|
47
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
48
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
49
|
+
of this License, Derivative Works shall not include works that remain
|
|
50
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
51
|
+
the Work and Derivative Works thereof.
|
|
52
|
+
|
|
53
|
+
"Contribution" shall mean any work of authorship, including
|
|
54
|
+
the original version of the Work and any modifications or additions
|
|
55
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
56
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
57
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
58
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
59
|
+
means any form of electronic, verbal, or written communication sent
|
|
60
|
+
to the Licensor or its representatives, including but not limited to
|
|
61
|
+
communication on electronic mailing lists, source code control systems,
|
|
62
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
63
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
64
|
+
excluding communication that is conspicuously marked or otherwise
|
|
65
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
66
|
+
|
|
67
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
68
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
69
|
+
subsequently incorporated within the Work.
|
|
70
|
+
|
|
71
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
72
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
73
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
74
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
75
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
76
|
+
Work and such Derivative Works in Source or Object form.
|
|
77
|
+
|
|
78
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
79
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
80
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
81
|
+
(except as stated in this section) patent license to make, have made,
|
|
82
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
83
|
+
where such license applies only to those patent claims licensable
|
|
84
|
+
by such Contributor that are necessarily infringed by their
|
|
85
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
86
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
87
|
+
institute patent litigation against any entity (including a
|
|
88
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
89
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
90
|
+
or contributory patent infringement, then any patent licenses
|
|
91
|
+
granted to You under this License for that Work shall terminate
|
|
92
|
+
as of the date such litigation is filed.
|
|
93
|
+
|
|
94
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
95
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
96
|
+
modifications, and in Source or Object form, provided that You
|
|
97
|
+
meet the following conditions:
|
|
98
|
+
|
|
99
|
+
(a) You must give any other recipients of the Work or
|
|
100
|
+
Derivative Works a copy of this License; and
|
|
101
|
+
|
|
102
|
+
(b) You must cause any modified files to carry prominent notices
|
|
103
|
+
stating that You changed the files; and
|
|
104
|
+
|
|
105
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
106
|
+
that You distribute, all copyright, patent, trademark, and
|
|
107
|
+
attribution notices from the Source form of the Work,
|
|
108
|
+
excluding those notices that do not pertain to any part of
|
|
109
|
+
the Derivative Works; and
|
|
110
|
+
|
|
111
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
112
|
+
distribution, then any Derivative Works that You distribute must
|
|
113
|
+
include a readable copy of the attribution notices contained
|
|
114
|
+
within such NOTICE file, excluding those notices that do not
|
|
115
|
+
pertain to any part of the Derivative Works, in at least one
|
|
116
|
+
of the following places: within a NOTICE text file distributed
|
|
117
|
+
as part of the Derivative Works; within the Source form or
|
|
118
|
+
documentation, if provided along with the Derivative Works; or,
|
|
119
|
+
within a display generated by the Derivative Works, if and
|
|
120
|
+
wherever such third-party notices normally appear. The contents
|
|
121
|
+
of the NOTICE file are for informational purposes only and
|
|
122
|
+
do not modify the License. You may add Your own attribution
|
|
123
|
+
notices within Derivative Works that You distribute, alongside
|
|
124
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
125
|
+
that such additional attribution notices cannot be construed
|
|
126
|
+
as modifying the License.
|
|
127
|
+
|
|
128
|
+
You may add Your own copyright statement to Your modifications and
|
|
129
|
+
may provide additional or different license terms and conditions
|
|
130
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
131
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
132
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
133
|
+
the conditions stated in this License.
|
|
134
|
+
|
|
135
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
136
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
137
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
138
|
+
this License, without any additional terms or conditions.
|
|
139
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
140
|
+
the terms of any separate license agreement you may have executed
|
|
141
|
+
with Licensor regarding such Contributions.
|
|
142
|
+
|
|
143
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
144
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
145
|
+
except as required for reasonable and customary use in describing the
|
|
146
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
147
|
+
|
|
148
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
149
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
150
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
151
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
152
|
+
implied, including, without limitation, any warranties or conditions
|
|
153
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
154
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
155
|
+
appropriateness of using or redistributing the Work and assume any
|
|
156
|
+
risks associated with Your exercise of permissions under this License.
|
|
157
|
+
|
|
158
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
159
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
160
|
+
unless required by applicable law (such as deliberate and grossly
|
|
161
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
162
|
+
liable to You for damages, including any direct, indirect, special,
|
|
163
|
+
incidental, or consequential damages of any character arising as a
|
|
164
|
+
result of this License or out of the use or inability to use the
|
|
165
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
166
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
167
|
+
other commercial damages or losses), even if such Contributor
|
|
168
|
+
has been advised of the possibility of such damages.
|
|
169
|
+
|
|
170
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
171
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
172
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
173
|
+
or other liability obligations and/or rights consistent with this
|
|
174
|
+
License. However, in accepting such obligations, You may act only
|
|
175
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
176
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
177
|
+
defend, and hold each Contributor harmless for any liability
|
|
178
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
179
|
+
of your accepting any such warranty or additional liability.
|
|
180
|
+
|
|
181
|
+
END OF TERMS AND CONDITIONS
|
|
182
|
+
|
|
183
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
184
|
+
|
|
185
|
+
To apply the Apache License to your work, attach the following
|
|
186
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
|
187
|
+
replaced with your own identifying information. (Don't include
|
|
188
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
189
|
+
comment syntax for the file format. We also recommend that a
|
|
190
|
+
file or class name and description of purpose be included on the
|
|
191
|
+
same "printed page" as the copyright notice for easier
|
|
192
|
+
identification within third-party archives.
|
|
193
|
+
|
|
194
|
+
Copyright {yyyy} {name of copyright owner}
|
|
195
|
+
|
|
196
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
197
|
+
you may not use this file except in compliance with the License.
|
|
198
|
+
You may obtain a copy of the License at
|
|
199
|
+
|
|
200
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
201
|
+
|
|
202
|
+
Unless required by applicable law or agreed to in writing, software
|
|
203
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
204
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
205
|
+
See the License for the specific language governing permissions and
|
|
206
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# @simplysf/simply-cicd-core
|
|
2
|
+
|
|
3
|
+
[](https://npmjs.com/@simplysf/simply-cicd-core) [](https://npmjs.com/@simplysf/simply-cicd-core) [](https://raw.githubusercontent.com/SimplySF/simply-node/main/LICENSE.txt)
|
|
4
|
+
|
|
5
|
+
ALM issue linking (Jira, GitLab Issues) and VCS API clients (GitHub, GitLab). This is not a Salesforce CLI plugin — it's the library layer behind [`@simplysf/simply-cicd`](https://github.com/SimplySF/simply-plugins/tree/main/packages/simply-cicd)'s ALM/VCS integrations, published separately so it can be imported directly by anything that wants the same logic (a bot, a script, a CI job) without pulling in the CLI framework.
|
|
6
|
+
|
|
7
|
+
Only `alm/` and `vcs/` moved here — `@simplysf/simply-cicd` itself still owns everything CI-pipeline-shaped (running builds/deploys, shelling to `sf`/`git`, sending pipeline notifications). See [docs/design/0037-simply-cicd-core.md](https://github.com/SimplySF/simply-node/blob/main/docs/design/0037-simply-cicd-core.md) for the boundary and why the rest stayed behind.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @simplysf/simply-cicd-core
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Requires Node.js `>=22` and either `"type": "module"` or a dynamic `import()` — this package ships ESM only. Zero runtime dependencies — `vcs/`'s GitHub/GitLab clients use the platform `fetch`.
|
|
16
|
+
|
|
17
|
+
## API
|
|
18
|
+
|
|
19
|
+
Everything below is exported from the package root. Removing or renaming an export is a breaking change; see [`src/index.ts`](src/index.ts).
|
|
20
|
+
|
|
21
|
+
| Export | Description |
|
|
22
|
+
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------ |
|
|
23
|
+
| `createAlmProvider(kind)` | Builds an `AlmProvider` for a registered ALM tool (`'jira'`, `'gitlab-issues'`). |
|
|
24
|
+
| `listAlmProviderKinds()` | The ALM tools currently registered, for flag options and error messages. |
|
|
25
|
+
| `registerAlmProvider(...)` | Registers a custom `AlmProvider` implementation without modifying this package. |
|
|
26
|
+
| `JiraProvider` | Extracts `PROJECT-123`-style issue keys from commit-log text and renders them as plain-text/HTML links. |
|
|
27
|
+
| `GitLabIssuesProvider` | Extracts GitLab's bare `#123` issue references from commit-log text; project keys are not used. |
|
|
28
|
+
| `createVcsProvider(kind, options)` | Builds a `VcsProvider` for a registered platform (`'github'`, `'gitlab'`), given host/token options. |
|
|
29
|
+
| `listVcsProviderKinds()` | The VCS platforms currently registered. |
|
|
30
|
+
| `registerVcsProvider(...)` | Registers a custom `VcsProvider` implementation without modifying this package. |
|
|
31
|
+
| `GitHubProvider` | A `VcsProvider` backed by the GitHub REST API — branches, merge requests (pull requests), CI variables, etc. |
|
|
32
|
+
| `GitLabProvider` | A `VcsProvider` backed by the GitLab REST API v4 — same surface as `GitHubProvider`. |
|
|
33
|
+
|
|
34
|
+
Types (`AlmProviderKind`, `AlmIssueRef`, `AlmIssueRendering`, `AlmProvider`, `AlmProviderFactory`,
|
|
35
|
+
`VcsProviderKind`, `VcsProject`, `VcsProjectRef`, `VcsBranch`, `VcsCommit`, `VcsCommitLogEntry`,
|
|
36
|
+
`VcsMergeRequest`, `VcsProjectVariable`, `VcsTerminology`, `VcsCiContext`, `VcsProviderOptions`,
|
|
37
|
+
`VcsProvider`, `VcsProviderFactory`) are also exported from the package root.
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
import { createAlmProvider } from '@simplysf/simply-cicd-core';
|
|
41
|
+
|
|
42
|
+
const jira = createAlmProvider('jira');
|
|
43
|
+
const issues = jira.extractIssues(commitLog, ['PROJ']);
|
|
44
|
+
const { html } = jira.render(issues, 'https://example.atlassian.net/browse');
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
import { createVcsProvider } from '@simplysf/simply-cicd-core';
|
|
49
|
+
|
|
50
|
+
const gitlab = createVcsProvider('gitlab', { token: process.env.GITLAB_TOKEN });
|
|
51
|
+
const mr = await gitlab.findMergeRequest({ sourceBranch: 'feature/x' });
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Issues
|
|
55
|
+
|
|
56
|
+
Please report any issues at https://github.com/SimplySF/simply-node/issues
|
|
57
|
+
|
|
58
|
+
## Contributing
|
|
59
|
+
|
|
60
|
+
This package is part of the [`@simplysf/simply`](https://github.com/SimplySF/simply-node) monorepo. See [CONTRIBUTING.md](CONTRIBUTING.md) for what's specific to this package, and the repo's [root CONTRIBUTING.md](https://github.com/SimplySF/simply-node/blob/main/CONTRIBUTING.md) for repo structure, setup, commit conventions, and how to submit a pull request. Please also read our [Code of Conduct](https://github.com/SimplySF/simply-node/blob/main/CODE_OF_CONDUCT.md).
|
|
61
|
+
|
|
62
|
+
## License
|
|
63
|
+
|
|
64
|
+
Licensed under the [Apache-2.0](https://raw.githubusercontent.com/SimplySF/simply-node/main/LICENSE.txt) license.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { AlmIssueRef, AlmIssueRendering, AlmProvider } from './types.js';
|
|
2
|
+
/**
|
|
3
|
+
* An `AlmProvider` for GitLab Issues, which numbers issues per project rather than prefixing them
|
|
4
|
+
* with a project key. `projectKeys` is therefore unused.
|
|
5
|
+
*/
|
|
6
|
+
export declare class GitLabIssuesProvider implements AlmProvider {
|
|
7
|
+
readonly kind: "gitlab-issues";
|
|
8
|
+
readonly issueNoun = "issue";
|
|
9
|
+
extractIssues(commitLog: string, projectKeys?: string[]): AlmIssueRef[];
|
|
10
|
+
render(issues: AlmIssueRef[], baseUrl?: string): AlmIssueRendering;
|
|
11
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright (c) 2026, Clay Chipps.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
/**
|
|
17
|
+
* Matches GitLab's issue reference syntax: a bare `#123`, not preceded by a word character so that
|
|
18
|
+
* a trailing `#` in something like `abc#1` is still caught but `C#1` is not treated as an issue.
|
|
19
|
+
*/
|
|
20
|
+
const ISSUE_PATTERN = /(?<![\w#])#(?<number>\d+)\b/g;
|
|
21
|
+
/**
|
|
22
|
+
* An `AlmProvider` for GitLab Issues, which numbers issues per project rather than prefixing them
|
|
23
|
+
* with a project key. `projectKeys` is therefore unused.
|
|
24
|
+
*/
|
|
25
|
+
export class GitLabIssuesProvider {
|
|
26
|
+
kind = 'gitlab-issues';
|
|
27
|
+
issueNoun = 'issue';
|
|
28
|
+
/* eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars --
|
|
29
|
+
class-methods-use-this: part of the AlmProvider instance contract; matching needs no instance state.
|
|
30
|
+
no-unused-vars: `projectKeys` is declared to match the interface, but GitLab numbers issues per
|
|
31
|
+
project, so there are no key prefixes to filter on. */
|
|
32
|
+
extractIssues(commitLog, projectKeys = []) {
|
|
33
|
+
const numbers = new Set();
|
|
34
|
+
for (const match of commitLog.matchAll(ISSUE_PATTERN)) {
|
|
35
|
+
const parsed = Number(match.groups?.number);
|
|
36
|
+
if (Number.isInteger(parsed)) {
|
|
37
|
+
numbers.add(parsed);
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
// Issue numbers sort numerically; a lexicographic sort would put #10 before #9.
|
|
41
|
+
return [...numbers]
|
|
42
|
+
.sort((a, b) => a - b)
|
|
43
|
+
.map((number) => ({ key: `#${number}`, label: `#${number}`, urlSegment: String(number) }));
|
|
44
|
+
}
|
|
45
|
+
// eslint-disable-next-line class-methods-use-this -- part of the AlmProvider instance contract; rendering needs no instance state
|
|
46
|
+
render(issues, baseUrl) {
|
|
47
|
+
const plain = issues.map((issue) => issue.label).join(', ');
|
|
48
|
+
const html = baseUrl
|
|
49
|
+
? issues.map((issue) => `<a href='${baseUrl}/${issue.urlSegment}'>${issue.label}</a>`).join(', ')
|
|
50
|
+
: plain;
|
|
51
|
+
return { plain, html };
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
//# sourceMappingURL=gitlabIssues.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"gitlabIssues.js","sourceRoot":"","sources":["../../src/alm/gitlabIssues.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH;;;GAGG;AACH,MAAM,aAAa,GAAG,8BAA8B,CAAC;AAErD;;;GAGG;AACH,MAAM,OAAO,oBAAoB;IACf,IAAI,GAAG,eAAwB,CAAC;IAEhC,SAAS,GAAG,OAAO,CAAC;IAEpC;;;6DAGyD;IAClD,aAAa,CAAC,SAAiB,EAAE,cAAwB,EAAE;QAChE,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;QAClC,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YACtD,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAC5C,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC7B,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACtB,CAAC;QACH,CAAC;QAED,gFAAgF;QAChF,OAAO,CAAC,GAAG,OAAO,CAAC;aAChB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;aACrB,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,MAAM,EAAE,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED,kIAAkI;IAC3H,MAAM,CAAC,MAAqB,EAAE,OAAgB;QACnD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5D,MAAM,IAAI,GAAG,OAAO;YAClB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,OAAO,IAAI,KAAK,CAAC,UAAU,KAAK,KAAK,CAAC,KAAK,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YACjG,CAAC,CAAC,KAAK,CAAC;QACV,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IACzB,CAAC;CACF"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export { createAlmProvider, listAlmProviderKinds, registerAlmProvider } from './registry.js';
|
|
2
|
+
export { GitLabIssuesProvider } from './gitlabIssues.js';
|
|
3
|
+
export { JiraProvider } from './jira.js';
|
|
4
|
+
export type { AlmIssueRef, AlmIssueRendering, AlmProvider, AlmProviderFactory, AlmProviderKind } from './types.js';
|
package/lib/alm/index.js
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright (c) 2026, Clay Chipps.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
import { GitLabIssuesProvider } from './gitlabIssues.js';
|
|
17
|
+
import { JiraProvider } from './jira.js';
|
|
18
|
+
import { registerAlmProvider } from './registry.js';
|
|
19
|
+
registerAlmProvider('jira', () => new JiraProvider());
|
|
20
|
+
registerAlmProvider('gitlab-issues', () => new GitLabIssuesProvider());
|
|
21
|
+
export { createAlmProvider, listAlmProviderKinds, registerAlmProvider } from './registry.js';
|
|
22
|
+
export { GitLabIssuesProvider } from './gitlabIssues.js';
|
|
23
|
+
export { JiraProvider } from './jira.js';
|
|
24
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/alm/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEpD,mBAAmB,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,YAAY,EAAE,CAAC,CAAC;AACtD,mBAAmB,CAAC,eAAe,EAAE,GAAG,EAAE,CAAC,IAAI,oBAAoB,EAAE,CAAC,CAAC;AAEvE,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAE7F,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { AlmIssueRef, AlmIssueRendering, AlmProvider } from './types.js';
|
|
2
|
+
/** An `AlmProvider` for Jira, which keys issues as `PROJECT-123`. */
|
|
3
|
+
export declare class JiraProvider implements AlmProvider {
|
|
4
|
+
readonly kind: "jira";
|
|
5
|
+
readonly issueNoun = "story";
|
|
6
|
+
extractIssues(commitLog: string, projectKeys: string[]): AlmIssueRef[];
|
|
7
|
+
render(issues: AlmIssueRef[], baseUrl?: string): AlmIssueRendering;
|
|
8
|
+
}
|
package/lib/alm/jira.js
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright (c) 2026, Clay Chipps.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
/** Escapes a configured project key so it can be embedded in the match pattern literally. */
|
|
17
|
+
function escapeKey(projectKey) {
|
|
18
|
+
return projectKey.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&');
|
|
19
|
+
}
|
|
20
|
+
/** An `AlmProvider` for Jira, which keys issues as `PROJECT-123`. */
|
|
21
|
+
export class JiraProvider {
|
|
22
|
+
kind = 'jira';
|
|
23
|
+
issueNoun = 'story';
|
|
24
|
+
// eslint-disable-next-line class-methods-use-this -- part of the AlmProvider instance contract; matching needs no instance state
|
|
25
|
+
extractIssues(commitLog, projectKeys) {
|
|
26
|
+
if (projectKeys.length === 0) {
|
|
27
|
+
return [];
|
|
28
|
+
}
|
|
29
|
+
const pattern = new RegExp(`(?:${projectKeys.map(escapeKey).join('|')})-[0-9]+`, 'gi');
|
|
30
|
+
// Matching against the upper-cased log normalizes keys written in mixed case.
|
|
31
|
+
const matches = commitLog.toUpperCase().match(pattern) ?? [];
|
|
32
|
+
return [...new Set(matches)].sort().map((key) => ({ key, label: key, urlSegment: key }));
|
|
33
|
+
}
|
|
34
|
+
// eslint-disable-next-line class-methods-use-this -- part of the AlmProvider instance contract; rendering needs no instance state
|
|
35
|
+
render(issues, baseUrl) {
|
|
36
|
+
const plain = issues.map((issue) => issue.label).join(', ');
|
|
37
|
+
const html = baseUrl
|
|
38
|
+
? issues.map((issue) => `<a href='${baseUrl}/${issue.urlSegment}'>${issue.label}</a>`).join(', ')
|
|
39
|
+
: plain;
|
|
40
|
+
return { plain, html };
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
//# sourceMappingURL=jira.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"jira.js","sourceRoot":"","sources":["../../src/alm/jira.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,6FAA6F;AAC7F,SAAS,SAAS,CAAC,UAAkB;IACnC,OAAO,UAAU,CAAC,OAAO,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;AAC7D,CAAC;AAED,qEAAqE;AACrE,MAAM,OAAO,YAAY;IACP,IAAI,GAAG,MAAe,CAAC;IAEvB,SAAS,GAAG,OAAO,CAAC;IAEpC,iIAAiI;IAC1H,aAAa,CAAC,SAAiB,EAAE,WAAqB;QAC3D,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,MAAM,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QACvF,8EAA8E;QAC9E,MAAM,OAAO,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAE7D,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAC3F,CAAC;IAED,kIAAkI;IAC3H,MAAM,CAAC,MAAqB,EAAE,OAAgB;QACnD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5D,MAAM,IAAI,GAAG,OAAO;YAClB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,OAAO,IAAI,KAAK,CAAC,UAAU,KAAK,KAAK,CAAC,KAAK,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YACjG,CAAC,CAAC,KAAK,CAAC;QACV,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IACzB,CAAC;CACF"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { AlmProvider, AlmProviderFactory, AlmProviderKind } from './types.js';
|
|
2
|
+
/**
|
|
3
|
+
* Registers an ALM implementation. Built-in providers register themselves when `./index.js` is
|
|
4
|
+
* imported; call this directly to add a tracker without modifying this package.
|
|
5
|
+
*/
|
|
6
|
+
export declare function registerAlmProvider(kind: AlmProviderKind, factory: AlmProviderFactory): void;
|
|
7
|
+
/** The trackers currently registered, for flag options and error messages. */
|
|
8
|
+
export declare function listAlmProviderKinds(): AlmProviderKind[];
|
|
9
|
+
/** Builds a provider for the given ALM tool. */
|
|
10
|
+
export declare function createAlmProvider(kind: AlmProviderKind): AlmProvider;
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright (c) 2026, Clay Chipps.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
const factories = new Map();
|
|
17
|
+
/**
|
|
18
|
+
* Registers an ALM implementation. Built-in providers register themselves when `./index.js` is
|
|
19
|
+
* imported; call this directly to add a tracker without modifying this package.
|
|
20
|
+
*/
|
|
21
|
+
export function registerAlmProvider(kind, factory) {
|
|
22
|
+
factories.set(kind, factory);
|
|
23
|
+
}
|
|
24
|
+
/** The trackers currently registered, for flag options and error messages. */
|
|
25
|
+
export function listAlmProviderKinds() {
|
|
26
|
+
return [...factories.keys()].sort();
|
|
27
|
+
}
|
|
28
|
+
/** Builds a provider for the given ALM tool. */
|
|
29
|
+
export function createAlmProvider(kind) {
|
|
30
|
+
const factory = factories.get(kind);
|
|
31
|
+
if (!factory) {
|
|
32
|
+
const known = listAlmProviderKinds().join(', ');
|
|
33
|
+
throw new Error(`ALM provider "${kind}" is not supported. Registered providers: ${known}.`);
|
|
34
|
+
}
|
|
35
|
+
return factory();
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=registry.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../src/alm/registry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,MAAM,SAAS,GAAG,IAAI,GAAG,EAAuC,CAAC;AAEjE;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAqB,EAAE,OAA2B;IACpF,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC/B,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,oBAAoB;IAClC,OAAO,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AACtC,CAAC;AAED,gDAAgD;AAChD,MAAM,UAAU,iBAAiB,CAAC,IAAqB;IACrD,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,KAAK,GAAG,oBAAoB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAc,6CAA6C,KAAK,GAAG,CAAC,CAAC;IACxG,CAAC;IACD,OAAO,OAAO,EAAE,CAAC;AACnB,CAAC"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/** The set of application-lifecycle-management tools `simply-cicd` knows how to reference. */
|
|
2
|
+
export type AlmProviderKind = 'jira' | 'gitlab-issues';
|
|
3
|
+
/** A single issue reference found in a commit log, normalized across ALM tools. */
|
|
4
|
+
export type AlmIssueRef = {
|
|
5
|
+
/** The reference exactly as it was matched, e.g. `ABC-123` or `#42`. */
|
|
6
|
+
key: string;
|
|
7
|
+
/** How the reference is shown to a reader. */
|
|
8
|
+
label: string;
|
|
9
|
+
/** Path segment appended to the base URL to link the issue, e.g. `ABC-123` or `42`. */
|
|
10
|
+
urlSegment: string;
|
|
11
|
+
};
|
|
12
|
+
/** A rendered set of issue references: always plain text, plus HTML links when a base URL is known. */
|
|
13
|
+
export type AlmIssueRendering = {
|
|
14
|
+
plain: string;
|
|
15
|
+
html: string;
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* An issue-tracker integration, abstracted so that the notification path never encodes one tool's
|
|
19
|
+
* key format or link shape. Only the parts that genuinely differ between trackers live here: how a
|
|
20
|
+
* reference is recognized in a commit message, and how it is displayed and linked.
|
|
21
|
+
*/
|
|
22
|
+
export interface AlmProvider {
|
|
23
|
+
readonly kind: AlmProviderKind;
|
|
24
|
+
/** What this tool calls the things it tracks, for user-facing text. */
|
|
25
|
+
readonly issueNoun: string;
|
|
26
|
+
/**
|
|
27
|
+
* Finds issue references in a commit log. `projectKeys` is only meaningful for prefix-keyed
|
|
28
|
+
* trackers such as Jira; trackers that number issues per repository ignore it.
|
|
29
|
+
*/
|
|
30
|
+
extractIssues(commitLog: string, projectKeys: string[]): AlmIssueRef[];
|
|
31
|
+
/** Renders references as plain text, and as HTML links when `baseUrl` is provided. */
|
|
32
|
+
render(issues: AlmIssueRef[], baseUrl?: string): AlmIssueRendering;
|
|
33
|
+
}
|
|
34
|
+
/** Constructs a provider for one ALM tool. */
|
|
35
|
+
export type AlmProviderFactory = () => AlmProvider;
|
package/lib/alm/types.js
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright (c) 2026, Clay Chipps.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
export {};
|
|
17
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/alm/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG"}
|
package/lib/index.d.ts
ADDED
package/lib/index.js
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright (c) 2026, Clay Chipps.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
// Everything exported from this file is this package's public API and is semver-covered: adding an
|
|
17
|
+
// export is a minor/patch change, but removing or renaming one is breaking. `test/index.test.ts`
|
|
18
|
+
// pins the exported-key list down so an accidental removal fails a test instead of silently shipping
|
|
19
|
+
// in a patch release. See docs/design/0037-simply-cicd-core.md for why only `alm/`/`vcs/` are split
|
|
20
|
+
// out from `@simplysf/simply-cicd` (the CLI) — the rest of its `common/` stays behind.
|
|
21
|
+
//
|
|
22
|
+
// `alm/index.ts` and `vcs/index.ts` are themselves complete barrels (they register the built-in
|
|
23
|
+
// providers as an import side effect, same as they did inside `simply-cicd`) — re-exporting them
|
|
24
|
+
// here keeps that registration intact without duplicating either list.
|
|
25
|
+
export * from './alm/index.js';
|
|
26
|
+
export * from './vcs/index.js';
|
|
27
|
+
//# sourceMappingURL=index.js.map
|
package/lib/index.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,mGAAmG;AACnG,iGAAiG;AACjG,qGAAqG;AACrG,oGAAoG;AACpG,uFAAuF;AACvF,EAAE;AACF,gGAAgG;AAChG,iGAAiG;AACjG,uEAAuE;AAEvE,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { VcsBranch, VcsCiContext, VcsCommit, VcsCommitLogEntry, VcsMergeRequest, VcsProject, VcsProjectRef, VcsProjectVariable, VcsProvider, VcsProviderOptions, VcsTerminology } from './types.js';
|
|
2
|
+
/** A `VcsProvider` implementation for GitHub, backed by the GitHub REST API. */
|
|
3
|
+
export declare class GitHubProvider implements VcsProvider {
|
|
4
|
+
/** Used when no `--vcs-host` is supplied, so selecting a provider is enough to reach its SaaS instance. */
|
|
5
|
+
static readonly defaultHost = "github.com";
|
|
6
|
+
readonly kind: "github";
|
|
7
|
+
readonly terminology: VcsTerminology;
|
|
8
|
+
readonly host: string;
|
|
9
|
+
readonly apiUrl: string;
|
|
10
|
+
private readonly token;
|
|
11
|
+
constructor(options: VcsProviderOptions);
|
|
12
|
+
getCiContext(): VcsCiContext;
|
|
13
|
+
listProjects(orgId: string | number): Promise<VcsProject[]>;
|
|
14
|
+
getFileContent(project: VcsProjectRef, filePath: string, ref: string): Promise<string>;
|
|
15
|
+
compareRefs(project: VcsProjectRef, from: string, to: string): Promise<VcsCommitLogEntry[]>;
|
|
16
|
+
branchExists(project: VcsProjectRef, branchName: string): Promise<boolean>;
|
|
17
|
+
createBranch(project: VcsProjectRef, branchName: string, ref: string): Promise<VcsBranch>;
|
|
18
|
+
commitFile(project: VcsProjectRef, branchName: string, commitMessage: string, filePath: string, content: string): Promise<VcsCommit>;
|
|
19
|
+
findOpenMergeRequest(project: VcsProjectRef, sourceBranch: string, targetBranch: string): Promise<VcsMergeRequest | undefined>;
|
|
20
|
+
createMergeRequest(project: VcsProjectRef, sourceBranch: string, targetBranch: string, title: string, description: string, labels?: string[]): Promise<VcsMergeRequest>;
|
|
21
|
+
updateMergeRequest(project: VcsProjectRef, mergeRequest: VcsMergeRequest, title: string, description: string, labels?: string[]): Promise<VcsMergeRequest>;
|
|
22
|
+
getProjectVariables(project: VcsProjectRef): Promise<VcsProjectVariable[]>;
|
|
23
|
+
buildChangeRequestUrl(projectUrl: string, changeRequestIid: string | number): string;
|
|
24
|
+
buildAuthenticatedRemoteUrl(token: string, projectPath: string): string;
|
|
25
|
+
buildCiCloneUrl(ciJobToken: string, projectPath: string): string;
|
|
26
|
+
private request;
|
|
27
|
+
private getJson;
|
|
28
|
+
}
|