@sentry/junior-gocd 0.189.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 +201 -0
- package/README.md +73 -0
- package/dist/config.d.ts +15 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/index.d.ts +20 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +248 -0
- package/dist/tools/pipeline-history.d.ts +35 -0
- package/dist/tools/pipeline-history.d.ts.map +1 -0
- package/dist/tools/stage.d.ts +52 -0
- package/dist/tools/stage.d.ts.map +1 -0
- package/package.json +41 -0
- package/skills/gocd/SKILL.md +17 -0
- package/skills/gocd/SOURCES.md +4 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# @sentry/junior-gocd
|
|
2
|
+
|
|
3
|
+
`@sentry/junior-gocd` adds read-only GoCD tools to Junior. The package does not contain settings for a specific GoCD deployment.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import { defineJuniorPlugins } from "@sentry/junior";
|
|
9
|
+
import { gocdPlugin } from "@sentry/junior-gocd";
|
|
10
|
+
|
|
11
|
+
export const plugins = defineJuniorPlugins([
|
|
12
|
+
gocdPlugin({
|
|
13
|
+
// Optional. You can set GOCD_URL instead.
|
|
14
|
+
baseUrl: "https://gocd.example.com",
|
|
15
|
+
}),
|
|
16
|
+
]);
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Configuration
|
|
20
|
+
|
|
21
|
+
| Variable | Required | Use |
|
|
22
|
+
| ------------------- | ------------------------- | ------------------------------------------------------------------- |
|
|
23
|
+
| `GOCD_URL` | when `baseUrl` is omitted | The HTTPS base URL for GoCD, such as `https://gocd.example.com` |
|
|
24
|
+
| `GOCD_ACCESS_TOKEN` | for token authentication | A read-only GoCD API token used as the `Authorization` bearer token |
|
|
25
|
+
|
|
26
|
+
The configured base URL cannot change during a tool call. Junior allows network access and adds credentials for the domain when it registers the plugin.
|
|
27
|
+
|
|
28
|
+
For services such as Google IAP, the app can supply `grantForEgress` and `issueCredential` hooks instead of `GOCD_ACCESS_TOKEN`:
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
gocdPlugin({
|
|
32
|
+
baseUrl: "https://gocd.example.com",
|
|
33
|
+
hooks: {
|
|
34
|
+
grantForEgress() {
|
|
35
|
+
return {
|
|
36
|
+
access: "read",
|
|
37
|
+
name: "gocd-read",
|
|
38
|
+
reason: "read GoCD data",
|
|
39
|
+
};
|
|
40
|
+
},
|
|
41
|
+
async issueCredential() {
|
|
42
|
+
return {
|
|
43
|
+
type: "lease",
|
|
44
|
+
lease: {
|
|
45
|
+
expiresAt: new Date(Date.now() + 55 * 60_000).toISOString(),
|
|
46
|
+
headerTransforms: [
|
|
47
|
+
{
|
|
48
|
+
domain: "gocd.example.com",
|
|
49
|
+
headers: {
|
|
50
|
+
Authorization: "bearer ...",
|
|
51
|
+
"Proxy-Authorization": "Bearer ...",
|
|
52
|
+
},
|
|
53
|
+
},
|
|
54
|
+
],
|
|
55
|
+
},
|
|
56
|
+
};
|
|
57
|
+
},
|
|
58
|
+
},
|
|
59
|
+
});
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Tools
|
|
63
|
+
|
|
64
|
+
- `pipelineHistory`: returns recent runs for one pipeline
|
|
65
|
+
- `stage`: returns one stage run, its jobs, and failed job names
|
|
66
|
+
|
|
67
|
+
The tools use the GoCD 25.2.0 API:
|
|
68
|
+
|
|
69
|
+
- pipeline history: `GET /go/api/pipelines/:name/history` with `Accept: application/vnd.go.cd.v1+json`
|
|
70
|
+
- stage run: `GET /go/api/stages/:pipeline_name/:stage_name/instance/:pipeline_counter/:stage_counter` with `Accept: application/vnd.go.cd.v3+json`
|
|
71
|
+
- pipeline history limits `page_size` to 10 through 100
|
|
72
|
+
|
|
73
|
+
Keep pipeline names and other deployment-specific settings in the app that registers this plugin.
|
package/dist/config.d.ts
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/** GoCD connection settings supplied by the app. */
|
|
2
|
+
export interface GocdPluginOptions {
|
|
3
|
+
/**
|
|
4
|
+
* Optional default GoCD base URL, for example `https://gocd.example.com`.
|
|
5
|
+
* When omitted, tools require `GOCD_URL`.
|
|
6
|
+
*/
|
|
7
|
+
baseUrl?: string;
|
|
8
|
+
}
|
|
9
|
+
/** Return the hostname from a valid GoCD base URL. */
|
|
10
|
+
export declare function hostnameFromBaseUrl(baseUrl: string): string;
|
|
11
|
+
/** Resolve the absolute request URL for one GoCD API path. */
|
|
12
|
+
export declare function resolveGocdApiUrl(baseUrl: string, path: string): string;
|
|
13
|
+
/** Return the configured GoCD base URL. */
|
|
14
|
+
export declare function resolveGocdBaseUrl(options?: GocdPluginOptions): string;
|
|
15
|
+
//# sourceMappingURL=config.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,oDAAoD;AAEpD,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AA0BD,sDAAsD;AACtD,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAE3D;AAED,8DAA8D;AAC9D,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAKvE;AAED,2CAA2C;AAC3C,wBAAgB,kBAAkB,CAAC,OAAO,GAAE,iBAAsB,GAAG,MAAM,CAY1E"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GoCD plugin runtime boundary.
|
|
3
|
+
*
|
|
4
|
+
* This package owns general read-only GoCD tools. The app supplies the GoCD
|
|
5
|
+
* base URL and authentication. Keep deployment-specific settings in the app.
|
|
6
|
+
*/
|
|
7
|
+
import { type PluginHooks, type PluginRegistration } from "@sentry/junior-plugin-api";
|
|
8
|
+
import { type GocdPluginOptions } from "./config.js";
|
|
9
|
+
export type GocdCredentialHooks = Pick<PluginHooks, "grantForEgress" | "issueCredential" | "onEgressResponse">;
|
|
10
|
+
export interface GocdPluginRegistrationOptions extends GocdPluginOptions {
|
|
11
|
+
/**
|
|
12
|
+
* Optional credential hooks supplied by the app.
|
|
13
|
+
* When omitted, Junior uses `GOCD_ACCESS_TOKEN` for the configured domain.
|
|
14
|
+
*/
|
|
15
|
+
hooks?: GocdCredentialHooks;
|
|
16
|
+
}
|
|
17
|
+
/** Register read-only GoCD tools. */
|
|
18
|
+
export declare function gocdPlugin(options?: GocdPluginRegistrationOptions): PluginRegistration;
|
|
19
|
+
export { hostnameFromBaseUrl, resolveGocdApiUrl, resolveGocdBaseUrl, type GocdPluginOptions, } from "./config.js";
|
|
20
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAEL,KAAK,WAAW,EAEhB,KAAK,kBAAkB,EACxB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAuB,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAI1E,MAAM,MAAM,mBAAmB,GAAG,IAAI,CACpC,WAAW,EACX,gBAAgB,GAAG,iBAAiB,GAAG,kBAAkB,CAC1D,CAAC;AAEF,MAAM,WAAW,6BAA8B,SAAQ,iBAAiB;IACtE;;;OAGG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC;CAC7B;AAUD,qCAAqC;AACrC,wBAAgB,UAAU,CACxB,OAAO,GAAE,6BAAkC,GAC1C,kBAAkB,CA8CpB;AAED,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,KAAK,iBAAiB,GACvB,MAAM,aAAa,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,248 @@
|
|
|
1
|
+
// src/index.ts
|
|
2
|
+
import {
|
|
3
|
+
defineJuniorPlugin
|
|
4
|
+
} from "@sentry/junior-plugin-api";
|
|
5
|
+
|
|
6
|
+
// src/config.ts
|
|
7
|
+
function parseBaseUrl(baseUrl) {
|
|
8
|
+
let url;
|
|
9
|
+
try {
|
|
10
|
+
url = new URL(baseUrl);
|
|
11
|
+
} catch {
|
|
12
|
+
throw new Error(`Invalid GoCD base URL: ${baseUrl}`);
|
|
13
|
+
}
|
|
14
|
+
if (url.protocol !== "https:") {
|
|
15
|
+
throw new Error("GoCD base URL must use https");
|
|
16
|
+
}
|
|
17
|
+
if (url.username || url.password || url.pathname !== "/" || url.search || url.hash) {
|
|
18
|
+
throw new Error(
|
|
19
|
+
"GoCD base URL cannot include credentials, a path, a query, or a fragment"
|
|
20
|
+
);
|
|
21
|
+
}
|
|
22
|
+
return url;
|
|
23
|
+
}
|
|
24
|
+
function hostnameFromBaseUrl(baseUrl) {
|
|
25
|
+
return parseBaseUrl(baseUrl).hostname;
|
|
26
|
+
}
|
|
27
|
+
function resolveGocdApiUrl(baseUrl, path) {
|
|
28
|
+
if (!path.startsWith("/go/")) {
|
|
29
|
+
throw new Error("GoCD API paths must start with /go/");
|
|
30
|
+
}
|
|
31
|
+
return `${parseBaseUrl(baseUrl).origin}${path}`;
|
|
32
|
+
}
|
|
33
|
+
function resolveGocdBaseUrl(options = {}) {
|
|
34
|
+
const configuredBaseUrl = (options.baseUrl ?? process.env.GOCD_URL ?? "").trim();
|
|
35
|
+
if (!configuredBaseUrl) {
|
|
36
|
+
throw new Error(
|
|
37
|
+
"GoCD base URL is required. Configure gocdPlugin({ baseUrl }) or set GOCD_URL."
|
|
38
|
+
);
|
|
39
|
+
}
|
|
40
|
+
return parseBaseUrl(configuredBaseUrl).origin;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
// src/tools/pipeline-history.ts
|
|
44
|
+
import {
|
|
45
|
+
definePluginTool,
|
|
46
|
+
pluginToolOutputSchema
|
|
47
|
+
} from "@sentry/junior-plugin-api";
|
|
48
|
+
import { z } from "zod";
|
|
49
|
+
var inputSchema = z.object({
|
|
50
|
+
pipeline: z.string().trim().min(1).describe("Exact GoCD pipeline name."),
|
|
51
|
+
count: z.number().int().min(1).max(100).default(20)
|
|
52
|
+
}).strict();
|
|
53
|
+
var outputSchema = pluginToolOutputSchema.extend({
|
|
54
|
+
target: z.literal("pipeline_history"),
|
|
55
|
+
baseUrl: z.string(),
|
|
56
|
+
pipeline: z.string(),
|
|
57
|
+
runs: z.array(z.unknown())
|
|
58
|
+
});
|
|
59
|
+
function createGocdPipelineHistoryTool(ctx, options = {}) {
|
|
60
|
+
return definePluginTool({
|
|
61
|
+
annotations: {
|
|
62
|
+
destructiveHint: false,
|
|
63
|
+
idempotentHint: true,
|
|
64
|
+
openWorldHint: true,
|
|
65
|
+
readOnlyHint: true
|
|
66
|
+
},
|
|
67
|
+
description: "Fetch recent runs for an exact GoCD pipeline. Use this to inspect deployment history and stage or job results.",
|
|
68
|
+
inputSchema,
|
|
69
|
+
outputSchema,
|
|
70
|
+
async execute(input) {
|
|
71
|
+
const baseUrl = resolveGocdBaseUrl(options);
|
|
72
|
+
const pageSize = Math.min(100, Math.max(10, input.count));
|
|
73
|
+
const response = await ctx.egress.fetch({
|
|
74
|
+
operation: "gocd.pipeline.history",
|
|
75
|
+
provider: "gocd",
|
|
76
|
+
request: new Request(
|
|
77
|
+
resolveGocdApiUrl(
|
|
78
|
+
baseUrl,
|
|
79
|
+
`/go/api/pipelines/${encodeURIComponent(input.pipeline)}/history?page_size=${pageSize}`
|
|
80
|
+
),
|
|
81
|
+
{
|
|
82
|
+
headers: {
|
|
83
|
+
Accept: "application/vnd.go.cd.v1+json"
|
|
84
|
+
},
|
|
85
|
+
method: "GET"
|
|
86
|
+
}
|
|
87
|
+
)
|
|
88
|
+
});
|
|
89
|
+
if (!response.ok) {
|
|
90
|
+
throw new Error(
|
|
91
|
+
`GoCD pipeline history failed with HTTP ${response.status}`
|
|
92
|
+
);
|
|
93
|
+
}
|
|
94
|
+
const body = z.object({ pipelines: z.array(z.unknown()) }).passthrough().parse(await response.json());
|
|
95
|
+
return {
|
|
96
|
+
baseUrl,
|
|
97
|
+
pipeline: input.pipeline,
|
|
98
|
+
runs: body.pipelines.slice(0, input.count),
|
|
99
|
+
target: "pipeline_history"
|
|
100
|
+
};
|
|
101
|
+
}
|
|
102
|
+
});
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
// src/tools/stage.ts
|
|
106
|
+
import {
|
|
107
|
+
definePluginTool as definePluginTool2,
|
|
108
|
+
pluginToolOutputSchema as pluginToolOutputSchema2
|
|
109
|
+
} from "@sentry/junior-plugin-api";
|
|
110
|
+
import { z as z2 } from "zod";
|
|
111
|
+
var inputSchema2 = z2.object({
|
|
112
|
+
pipeline: z2.string().trim().min(1).describe("Exact GoCD pipeline name."),
|
|
113
|
+
pipelineCounter: z2.number().int().min(1).describe("Pipeline run counter (integer)."),
|
|
114
|
+
stage: z2.string().trim().min(1).describe("Exact stage name."),
|
|
115
|
+
stageCounter: z2.number().int().min(1).describe("Stage run counter (integer).")
|
|
116
|
+
}).strict();
|
|
117
|
+
var jobSchema = z2.object({
|
|
118
|
+
name: z2.string(),
|
|
119
|
+
result: z2.string().optional(),
|
|
120
|
+
state: z2.string().optional()
|
|
121
|
+
}).passthrough();
|
|
122
|
+
var stageBodySchema = z2.object({
|
|
123
|
+
result: z2.string().optional(),
|
|
124
|
+
_embedded: z2.object({ jobs: z2.array(jobSchema).default([]) })
|
|
125
|
+
}).passthrough();
|
|
126
|
+
var outputSchema2 = pluginToolOutputSchema2.extend({
|
|
127
|
+
target: z2.literal("stage"),
|
|
128
|
+
baseUrl: z2.string(),
|
|
129
|
+
link: z2.string(),
|
|
130
|
+
pipeline: z2.string(),
|
|
131
|
+
pipelineCounter: z2.number(),
|
|
132
|
+
stage: z2.string(),
|
|
133
|
+
stageCounter: z2.number(),
|
|
134
|
+
result: z2.string(),
|
|
135
|
+
jobs: z2.array(
|
|
136
|
+
z2.object({ name: z2.string(), result: z2.string(), state: z2.string() })
|
|
137
|
+
),
|
|
138
|
+
failedJobs: z2.array(z2.string())
|
|
139
|
+
});
|
|
140
|
+
function createGocdStageTool(ctx, options = {}) {
|
|
141
|
+
return definePluginTool2({
|
|
142
|
+
annotations: {
|
|
143
|
+
destructiveHint: false,
|
|
144
|
+
idempotentHint: true,
|
|
145
|
+
openWorldHint: true,
|
|
146
|
+
readOnlyHint: true
|
|
147
|
+
},
|
|
148
|
+
description: "Fetch one exact GoCD stage run, its jobs, and failed job names. Identify the run with its pipeline name, pipeline counter, stage name, and stage counter.",
|
|
149
|
+
inputSchema: inputSchema2,
|
|
150
|
+
outputSchema: outputSchema2,
|
|
151
|
+
async execute(input) {
|
|
152
|
+
const baseUrl = resolveGocdBaseUrl(options);
|
|
153
|
+
const path = `/go/api/stages/${encodeURIComponent(input.pipeline)}/${encodeURIComponent(input.stage)}/instance/${input.pipelineCounter}/${input.stageCounter}`;
|
|
154
|
+
const response = await ctx.egress.fetch({
|
|
155
|
+
operation: "gocd.stage",
|
|
156
|
+
provider: "gocd",
|
|
157
|
+
request: new Request(resolveGocdApiUrl(baseUrl, path), {
|
|
158
|
+
headers: { Accept: "application/vnd.go.cd.v3+json" },
|
|
159
|
+
method: "GET"
|
|
160
|
+
})
|
|
161
|
+
});
|
|
162
|
+
if (!response.ok) {
|
|
163
|
+
throw new Error(`GoCD stage failed with HTTP ${response.status}`);
|
|
164
|
+
}
|
|
165
|
+
const body = stageBodySchema.parse(await response.json());
|
|
166
|
+
const jobs = body._embedded.jobs.map((job) => ({
|
|
167
|
+
name: job.name,
|
|
168
|
+
result: job.result ?? "Unknown",
|
|
169
|
+
state: job.state ?? "Unknown"
|
|
170
|
+
}));
|
|
171
|
+
const link = resolveGocdApiUrl(
|
|
172
|
+
baseUrl,
|
|
173
|
+
`/go/pipelines/${encodeURIComponent(input.pipeline)}/${input.pipelineCounter}/${encodeURIComponent(input.stage)}/${input.stageCounter}`
|
|
174
|
+
);
|
|
175
|
+
return {
|
|
176
|
+
target: "stage",
|
|
177
|
+
baseUrl,
|
|
178
|
+
link,
|
|
179
|
+
pipeline: input.pipeline,
|
|
180
|
+
pipelineCounter: input.pipelineCounter,
|
|
181
|
+
stage: input.stage,
|
|
182
|
+
stageCounter: input.stageCounter,
|
|
183
|
+
result: body.result ?? "Unknown",
|
|
184
|
+
jobs,
|
|
185
|
+
failedJobs: jobs.filter((job) => job.result === "Failed").map((job) => job.name)
|
|
186
|
+
};
|
|
187
|
+
}
|
|
188
|
+
});
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
// src/index.ts
|
|
192
|
+
function resolveManifestHostname(options) {
|
|
193
|
+
const baseUrl = (options.baseUrl ?? process.env.GOCD_URL ?? "").trim();
|
|
194
|
+
if (!baseUrl) return void 0;
|
|
195
|
+
return hostnameFromBaseUrl(baseUrl);
|
|
196
|
+
}
|
|
197
|
+
function gocdPlugin(options = {}) {
|
|
198
|
+
const hostname = resolveManifestHostname(options);
|
|
199
|
+
const credentialHooks = options.hooks;
|
|
200
|
+
const usesCredentialHooks = Boolean(
|
|
201
|
+
credentialHooks?.grantForEgress || credentialHooks?.issueCredential
|
|
202
|
+
);
|
|
203
|
+
const manifest = {
|
|
204
|
+
description: "Read GoCD pipeline and stage results",
|
|
205
|
+
displayName: "GoCD",
|
|
206
|
+
envVars: {
|
|
207
|
+
GOCD_ACCESS_TOKEN: {},
|
|
208
|
+
GOCD_URL: {}
|
|
209
|
+
},
|
|
210
|
+
name: "gocd"
|
|
211
|
+
};
|
|
212
|
+
if (hostname) {
|
|
213
|
+
manifest.domains = [hostname];
|
|
214
|
+
if (!usesCredentialHooks) {
|
|
215
|
+
manifest.apiHeaders = {
|
|
216
|
+
Authorization: "bearer ${GOCD_ACCESS_TOKEN}"
|
|
217
|
+
};
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
const hooks = {
|
|
221
|
+
tools(ctx) {
|
|
222
|
+
return {
|
|
223
|
+
pipelineHistory: createGocdPipelineHistoryTool(ctx, options),
|
|
224
|
+
stage: createGocdStageTool(ctx, options)
|
|
225
|
+
};
|
|
226
|
+
}
|
|
227
|
+
};
|
|
228
|
+
if (credentialHooks?.grantForEgress) {
|
|
229
|
+
hooks.grantForEgress = credentialHooks.grantForEgress;
|
|
230
|
+
}
|
|
231
|
+
if (credentialHooks?.issueCredential) {
|
|
232
|
+
hooks.issueCredential = credentialHooks.issueCredential;
|
|
233
|
+
}
|
|
234
|
+
if (credentialHooks?.onEgressResponse) {
|
|
235
|
+
hooks.onEgressResponse = credentialHooks.onEgressResponse;
|
|
236
|
+
}
|
|
237
|
+
return defineJuniorPlugin({
|
|
238
|
+
packageName: "@sentry/junior-gocd",
|
|
239
|
+
manifest,
|
|
240
|
+
hooks
|
|
241
|
+
});
|
|
242
|
+
}
|
|
243
|
+
export {
|
|
244
|
+
gocdPlugin,
|
|
245
|
+
hostnameFromBaseUrl,
|
|
246
|
+
resolveGocdApiUrl,
|
|
247
|
+
resolveGocdBaseUrl
|
|
248
|
+
};
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { type ToolRegistrationHookContext } from "@sentry/junior-plugin-api";
|
|
2
|
+
import { type GocdPluginOptions } from "../config.js";
|
|
3
|
+
/**
|
|
4
|
+
* Return recent runs for one GoCD pipeline.
|
|
5
|
+
*
|
|
6
|
+
* Uses GoCD 25.2.0 `GET /go/api/pipelines/:name/history` with Accept v1.
|
|
7
|
+
* `page_size` must stay in 10..100. Smaller counts are clamped, then sliced.
|
|
8
|
+
*/
|
|
9
|
+
export declare function createGocdPipelineHistoryTool(ctx: ToolRegistrationHookContext, options?: GocdPluginOptions): import("@sentry/junior-plugin-api").PluginToolDefinition<{
|
|
10
|
+
pipeline: string;
|
|
11
|
+
count: number;
|
|
12
|
+
}, {
|
|
13
|
+
[x: string]: unknown;
|
|
14
|
+
target: "pipeline_history";
|
|
15
|
+
baseUrl: string;
|
|
16
|
+
pipeline: string;
|
|
17
|
+
runs: unknown[];
|
|
18
|
+
truncated?: boolean | undefined;
|
|
19
|
+
continuation?: {
|
|
20
|
+
arguments: Record<string, unknown>;
|
|
21
|
+
reason?: string | undefined;
|
|
22
|
+
} | undefined;
|
|
23
|
+
}, {
|
|
24
|
+
[x: string]: unknown;
|
|
25
|
+
target: "pipeline_history";
|
|
26
|
+
baseUrl: string;
|
|
27
|
+
pipeline: string;
|
|
28
|
+
runs: unknown[];
|
|
29
|
+
truncated?: boolean | undefined;
|
|
30
|
+
continuation?: {
|
|
31
|
+
arguments: Record<string, unknown>;
|
|
32
|
+
reason?: string | undefined;
|
|
33
|
+
} | undefined;
|
|
34
|
+
}>;
|
|
35
|
+
//# sourceMappingURL=pipeline-history.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pipeline-history.d.ts","sourceRoot":"","sources":["../../src/tools/pipeline-history.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,2BAA2B,EACjC,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAGL,KAAK,iBAAiB,EACvB,MAAM,cAAc,CAAC;AAuBtB;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAC3C,GAAG,EAAE,2BAA2B,EAChC,OAAO,GAAE,iBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;GAkDhC"}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import { type ToolRegistrationHookContext } from "@sentry/junior-plugin-api";
|
|
2
|
+
import { type GocdPluginOptions } from "../config.js";
|
|
3
|
+
/** Return one exact GoCD stage run and its jobs. */
|
|
4
|
+
export declare function createGocdStageTool(ctx: ToolRegistrationHookContext, options?: GocdPluginOptions): import("@sentry/junior-plugin-api").PluginToolDefinition<{
|
|
5
|
+
pipeline: string;
|
|
6
|
+
pipelineCounter: number;
|
|
7
|
+
stage: string;
|
|
8
|
+
stageCounter: number;
|
|
9
|
+
}, {
|
|
10
|
+
[x: string]: unknown;
|
|
11
|
+
target: "stage";
|
|
12
|
+
baseUrl: string;
|
|
13
|
+
link: string;
|
|
14
|
+
pipeline: string;
|
|
15
|
+
pipelineCounter: number;
|
|
16
|
+
stage: string;
|
|
17
|
+
stageCounter: number;
|
|
18
|
+
result: string;
|
|
19
|
+
jobs: {
|
|
20
|
+
name: string;
|
|
21
|
+
result: string;
|
|
22
|
+
state: string;
|
|
23
|
+
}[];
|
|
24
|
+
failedJobs: string[];
|
|
25
|
+
truncated?: boolean | undefined;
|
|
26
|
+
continuation?: {
|
|
27
|
+
arguments: Record<string, unknown>;
|
|
28
|
+
reason?: string | undefined;
|
|
29
|
+
} | undefined;
|
|
30
|
+
}, {
|
|
31
|
+
[x: string]: unknown;
|
|
32
|
+
target: "stage";
|
|
33
|
+
baseUrl: string;
|
|
34
|
+
link: string;
|
|
35
|
+
pipeline: string;
|
|
36
|
+
pipelineCounter: number;
|
|
37
|
+
stage: string;
|
|
38
|
+
stageCounter: number;
|
|
39
|
+
result: string;
|
|
40
|
+
jobs: {
|
|
41
|
+
name: string;
|
|
42
|
+
result: string;
|
|
43
|
+
state: string;
|
|
44
|
+
}[];
|
|
45
|
+
failedJobs: string[];
|
|
46
|
+
truncated?: boolean | undefined;
|
|
47
|
+
continuation?: {
|
|
48
|
+
arguments: Record<string, unknown>;
|
|
49
|
+
reason?: string | undefined;
|
|
50
|
+
} | undefined;
|
|
51
|
+
}>;
|
|
52
|
+
//# sourceMappingURL=stage.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../src/tools/stage.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,2BAA2B,EACjC,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAGL,KAAK,iBAAiB,EACvB,MAAM,cAAc,CAAC;AAoEtB,oDAAoD;AACpD,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,2BAA2B,EAChC,OAAO,GAAE,iBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DhC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@sentry/junior-gocd",
|
|
3
|
+
"version": "0.189.0",
|
|
4
|
+
"private": false,
|
|
5
|
+
"publishConfig": {
|
|
6
|
+
"access": "public"
|
|
7
|
+
},
|
|
8
|
+
"type": "module",
|
|
9
|
+
"repository": {
|
|
10
|
+
"type": "git",
|
|
11
|
+
"url": "git+https://github.com/getsentry/junior.git",
|
|
12
|
+
"directory": "packages/junior-gocd"
|
|
13
|
+
},
|
|
14
|
+
"exports": {
|
|
15
|
+
".": {
|
|
16
|
+
"types": "./dist/index.d.ts",
|
|
17
|
+
"default": "./dist/index.js"
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
"files": [
|
|
21
|
+
"dist",
|
|
22
|
+
"skills"
|
|
23
|
+
],
|
|
24
|
+
"dependencies": {
|
|
25
|
+
"zod": "^4.4.3",
|
|
26
|
+
"@sentry/junior-plugin-api": "0.189.0"
|
|
27
|
+
},
|
|
28
|
+
"devDependencies": {
|
|
29
|
+
"@types/node": "^25.9.1",
|
|
30
|
+
"oxlint": "^1.66.0",
|
|
31
|
+
"tsup": "^8.5.1",
|
|
32
|
+
"typescript": "^6.0.3",
|
|
33
|
+
"vitest": "^4.1.7"
|
|
34
|
+
},
|
|
35
|
+
"scripts": {
|
|
36
|
+
"build": "tsup && tsc -p tsconfig.build.json --emitDeclarationOnly",
|
|
37
|
+
"lint": "oxlint --config ../junior/.oxlintrc.json --deny-warnings src tests tsup.config.ts vitest.config.ts",
|
|
38
|
+
"test": "vitest run",
|
|
39
|
+
"typecheck": "tsc --noEmit"
|
|
40
|
+
}
|
|
41
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: gocd
|
|
3
|
+
description: Read GoCD pipeline and stage results. Use when users ask about GoCD pipeline runs, deployment failures, run history, stages, or jobs.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# GoCD
|
|
7
|
+
|
|
8
|
+
Use the GoCD tools for current pipeline and stage data.
|
|
9
|
+
|
|
10
|
+
## Rules
|
|
11
|
+
|
|
12
|
+
- Treat GoCD access as read-only.
|
|
13
|
+
- Use the exact pipeline name.
|
|
14
|
+
- Use `pipelineHistory` to find recent pipeline runs.
|
|
15
|
+
- Use `stage` when the user needs the jobs or failed job names for one stage run.
|
|
16
|
+
- Do not claim that pipeline history includes console logs.
|
|
17
|
+
- If a request fails, state whether GoCD rejected it or the app lacks a base URL or credentials.
|