@backstage/plugin-scaffolder-backend-module-gitlab 0.4.1-next.0 → 0.4.1-next.2

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.
Files changed (5) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/dist/index.cjs.js +1790 -1468
  3. package/dist/index.cjs.js.map +1 -1
  4. package/dist/index.d.ts +169 -102
  5. package/package.json +9 -9
package/dist/index.d.ts CHANGED
@@ -1,95 +1,95 @@
1
1
  import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
2
- import { ScmIntegrationRegistry } from '@backstage/integration';
3
2
  import * as _backstage_types from '@backstage/types';
3
+ import { ScmIntegrationRegistry } from '@backstage/integration';
4
4
  import { Config } from '@backstage/config';
5
5
  import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
6
6
 
7
7
  /**
8
- * Creates an `gitlab:group:ensureExists` Scaffolder action.
9
- *
10
- * @public
11
- */
12
- declare const createGitlabGroupEnsureExistsAction: (options: {
13
- integrations: ScmIntegrationRegistry;
14
- }) => _backstage_plugin_scaffolder_node.TemplateAction<{
15
- path: string[];
16
- repoUrl: string;
17
- token?: string | undefined;
18
- }, {
19
- groupId?: number | undefined;
20
- }>;
21
-
22
- /**
23
- * Creates a `gitlab:projectDeployToken:create` Scaffolder action.
8
+ * Creates a new action that initializes a git repository of the content in the workspace
9
+ * and publishes it to GitLab.
24
10
  *
25
- * @param options - Templating configuration.
26
11
  * @public
27
12
  */
28
- declare const createGitlabProjectDeployTokenAction: (options: {
13
+ declare function createPublishGitlabAction(options: {
29
14
  integrations: ScmIntegrationRegistry;
30
- }) => _backstage_plugin_scaffolder_node.TemplateAction<{
31
- name: string;
15
+ config: Config;
16
+ }): _backstage_plugin_scaffolder_node.TemplateAction<{
32
17
  repoUrl: string;
33
- projectId: string | number;
34
- username?: string | undefined;
18
+ defaultBranch?: string | undefined;
19
+ /** @deprecated in favour of settings.visibility field */
20
+ repoVisibility?: "internal" | "private" | "public" | undefined;
21
+ sourcePath?: string | undefined;
35
22
  token?: string | undefined;
36
- scopes?: string[] | undefined;
37
- }, {
38
- user: string;
39
- deploy_token: string;
40
- }>;
23
+ gitCommitMessage?: string | undefined;
24
+ gitAuthorName?: string | undefined;
25
+ gitAuthorEmail?: string | undefined;
26
+ setUserAsOwner?: boolean | undefined;
27
+ /** @deprecated in favour of settings.topics field */
28
+ topics?: string[] | undefined;
29
+ settings?: {
30
+ path?: string | undefined;
31
+ auto_devops_enabled?: boolean | undefined;
32
+ ci_config_path?: string | undefined;
33
+ description?: string | undefined;
34
+ merge_method?: "merge" | "ff" | "rebase_merge" | undefined;
35
+ squash_option?: "always" | "never" | "default_off" | "default_on" | undefined;
36
+ topics?: string[] | undefined;
37
+ visibility?: "internal" | "private" | "public" | undefined;
38
+ } | undefined;
39
+ branches?: {
40
+ name: string;
41
+ protect?: boolean | undefined;
42
+ create?: boolean | undefined;
43
+ ref?: string | undefined;
44
+ }[] | undefined;
45
+ projectVariables?: {
46
+ key: string;
47
+ value: string;
48
+ description?: string | undefined;
49
+ variable_type?: string | undefined;
50
+ protected?: boolean | undefined;
51
+ masked?: boolean | undefined;
52
+ raw?: boolean | undefined;
53
+ environment_scope?: string | undefined;
54
+ }[] | undefined;
55
+ }, _backstage_types.JsonObject>;
41
56
 
42
57
  /**
43
- * Creates a `gitlab:projectAccessToken:create` Scaffolder action.
58
+ * Creates an `gitlab:group:ensureExists` Scaffolder action.
44
59
  *
45
- * @param options - Templating configuration.
46
60
  * @public
47
61
  */
48
- declare const createGitlabProjectAccessTokenAction: (options: {
62
+ declare const createGitlabGroupEnsureExistsAction: (options: {
49
63
  integrations: ScmIntegrationRegistry;
50
64
  }) => _backstage_plugin_scaffolder_node.TemplateAction<{
65
+ path: string[];
51
66
  repoUrl: string;
52
- projectId: string | number;
53
- name?: string | undefined;
54
67
  token?: string | undefined;
55
- scopes?: string[] | undefined;
56
- expiresAt?: string | undefined;
57
- accessLevel?: number | undefined;
58
68
  }, {
59
- access_token: string;
69
+ groupId?: number | undefined;
60
70
  }>;
61
71
 
62
72
  /**
63
- * Creates a `gitlab:projectVariable:create` Scaffolder action.
73
+ * Gitlab issue types as specified by gitlab api
64
74
  *
65
- * @param options - Templating configuration.
66
75
  * @public
67
76
  */
68
- declare const createGitlabProjectVariableAction: (options: {
69
- integrations: ScmIntegrationRegistry;
70
- }) => _backstage_plugin_scaffolder_node.TemplateAction<{
71
- key: string;
72
- value: string;
73
- repoUrl: string;
74
- projectId: string | number;
75
- variableType: string;
76
- raw?: boolean | undefined;
77
- token?: string | undefined;
78
- masked?: boolean | undefined;
79
- environmentScope?: string | undefined;
80
- variableProtected?: boolean | undefined;
81
- }, _backstage_types.JsonObject>;
82
-
77
+ declare enum IssueType {
78
+ ISSUE = "issue",
79
+ INCIDENT = "incident",
80
+ TEST = "test_case",
81
+ TASK = "task"
82
+ }
83
83
  /**
84
- * Gitlab issue types
84
+ * Gitlab issue state events for modifications
85
85
  *
86
86
  * @public
87
87
  */
88
- declare enum IssueType {
89
- ISSUE = "issue",
90
- INCIDENT = "incident",
91
- TEST = "test_case"
88
+ declare enum IssueStateEvent {
89
+ CLOSE = "close",
90
+ REOPEN = "reopen"
92
91
  }
92
+
93
93
  /**
94
94
  * Creates a `gitlab:issues:create` Scaffolder action.
95
95
  *
@@ -122,54 +122,42 @@ declare const createGitlabIssueAction: (options: {
122
122
  }>;
123
123
 
124
124
  /**
125
- * Creates a new action that initializes a git repository of the content in the workspace
126
- * and publishes it to GitLab.
125
+ * Creates a `gitlab:issue:edit` Scaffolder action.
127
126
  *
127
+ * @param options - Templating configuration.
128
128
  * @public
129
129
  */
130
- declare function createPublishGitlabAction(options: {
130
+ declare const editGitlabIssueAction: (options: {
131
131
  integrations: ScmIntegrationRegistry;
132
- config: Config;
133
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
132
+ }) => _backstage_plugin_scaffolder_node.TemplateAction<{
134
133
  repoUrl: string;
135
- defaultBranch?: string | undefined;
136
- /** @deprecated in favour of settings.visibility field */
137
- repoVisibility?: "internal" | "private" | "public" | undefined;
138
- sourcePath?: string | undefined;
134
+ projectId: number;
135
+ issueIid: number;
136
+ title?: string | undefined;
137
+ labels?: string | undefined;
138
+ description?: string | undefined;
139
+ weight?: number | undefined;
139
140
  token?: string | undefined;
140
- gitCommitMessage?: string | undefined;
141
- gitAuthorName?: string | undefined;
142
- gitAuthorEmail?: string | undefined;
143
- setUserAsOwner?: boolean | undefined;
144
- /** @deprecated in favour of settings.topics field */
145
- topics?: string[] | undefined;
146
- settings?: {
147
- path?: string | undefined;
148
- auto_devops_enabled?: boolean | undefined;
149
- ci_config_path?: string | undefined;
150
- description?: string | undefined;
151
- merge_method?: "merge" | "ff" | "rebase_merge" | undefined;
152
- squash_option?: "always" | "never" | "default_on" | "default_off" | undefined;
153
- topics?: string[] | undefined;
154
- visibility?: "internal" | "private" | "public" | undefined;
155
- } | undefined;
156
- branches?: {
157
- name: string;
158
- protect?: boolean | undefined;
159
- create?: boolean | undefined;
160
- ref?: string | undefined;
161
- }[] | undefined;
162
- projectVariables?: {
163
- key: string;
164
- value: string;
165
- description?: string | undefined;
166
- variable_type?: string | undefined;
167
- protected?: boolean | undefined;
168
- masked?: boolean | undefined;
169
- raw?: boolean | undefined;
170
- environment_scope?: string | undefined;
171
- }[] | undefined;
172
- }, _backstage_types.JsonObject>;
141
+ assignees?: number[] | undefined;
142
+ addLabels?: string | undefined;
143
+ confidential?: boolean | undefined;
144
+ milestoneId?: number | undefined;
145
+ removeLabels?: string | undefined;
146
+ stateEvent?: IssueStateEvent | undefined;
147
+ discussionLocked?: boolean | undefined;
148
+ epicId?: number | undefined;
149
+ dueDate?: string | undefined;
150
+ updatedAt?: string | undefined;
151
+ issueType?: IssueType | undefined;
152
+ }, {
153
+ state: string;
154
+ title: string;
155
+ projectId: number;
156
+ updatedAt: string;
157
+ issueUrl: string;
158
+ issueId: number;
159
+ issueIid: number;
160
+ }>;
173
161
 
174
162
  /**
175
163
  * Create a new action that creates a gitlab merge request.
@@ -194,6 +182,85 @@ declare const createPublishGitlabMergeRequestAction: (options: {
194
182
  assignee?: string | undefined;
195
183
  }, _backstage_types.JsonObject>;
196
184
 
185
+ /**
186
+ * Creates a `gitlab:pipeline:trigger` Scaffolder action.
187
+ *
188
+ * @param options - Templating configuration.
189
+ * @public
190
+ */
191
+ declare const createTriggerGitlabPipelineAction: (options: {
192
+ integrations: ScmIntegrationRegistry;
193
+ }) => _backstage_plugin_scaffolder_node.TemplateAction<{
194
+ branch: string;
195
+ repoUrl: string;
196
+ projectId: number;
197
+ tokenDescription: string;
198
+ token?: string | undefined;
199
+ }, {
200
+ pipelineUrl: string;
201
+ }>;
202
+
203
+ /**
204
+ * Creates a `gitlab:projectAccessToken:create` Scaffolder action.
205
+ *
206
+ * @param options - Templating configuration.
207
+ * @public
208
+ */
209
+ declare const createGitlabProjectAccessTokenAction: (options: {
210
+ integrations: ScmIntegrationRegistry;
211
+ }) => _backstage_plugin_scaffolder_node.TemplateAction<{
212
+ repoUrl: string;
213
+ projectId: string | number;
214
+ name?: string | undefined;
215
+ token?: string | undefined;
216
+ scopes?: string[] | undefined;
217
+ expiresAt?: string | undefined;
218
+ accessLevel?: number | undefined;
219
+ }, {
220
+ access_token: string;
221
+ }>;
222
+
223
+ /**
224
+ * Creates a `gitlab:projectDeployToken:create` Scaffolder action.
225
+ *
226
+ * @param options - Templating configuration.
227
+ * @public
228
+ */
229
+ declare const createGitlabProjectDeployTokenAction: (options: {
230
+ integrations: ScmIntegrationRegistry;
231
+ }) => _backstage_plugin_scaffolder_node.TemplateAction<{
232
+ name: string;
233
+ repoUrl: string;
234
+ projectId: string | number;
235
+ username?: string | undefined;
236
+ token?: string | undefined;
237
+ scopes?: string[] | undefined;
238
+ }, {
239
+ user: string;
240
+ deploy_token: string;
241
+ }>;
242
+
243
+ /**
244
+ * Creates a `gitlab:projectVariable:create` Scaffolder action.
245
+ *
246
+ * @param options - Templating configuration.
247
+ * @public
248
+ */
249
+ declare const createGitlabProjectVariableAction: (options: {
250
+ integrations: ScmIntegrationRegistry;
251
+ }) => _backstage_plugin_scaffolder_node.TemplateAction<{
252
+ key: string;
253
+ value: string;
254
+ repoUrl: string;
255
+ projectId: string | number;
256
+ variableType: string;
257
+ raw?: boolean | undefined;
258
+ token?: string | undefined;
259
+ masked?: boolean | undefined;
260
+ environmentScope?: string | undefined;
261
+ variableProtected?: boolean | undefined;
262
+ }, _backstage_types.JsonObject>;
263
+
197
264
  /**
198
265
  * Create a new action that commits into a gitlab repository.
199
266
  *
@@ -217,4 +284,4 @@ declare const createGitlabRepoPushAction: (options: {
217
284
  */
218
285
  declare const gitlabModule: () => _backstage_backend_plugin_api.BackendFeature;
219
286
 
220
- export { IssueType, createGitlabGroupEnsureExistsAction, createGitlabIssueAction, createGitlabProjectAccessTokenAction, createGitlabProjectDeployTokenAction, createGitlabProjectVariableAction, createGitlabRepoPushAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, gitlabModule as default };
287
+ export { IssueStateEvent, IssueType, createGitlabGroupEnsureExistsAction, createGitlabIssueAction, createGitlabProjectAccessTokenAction, createGitlabProjectDeployTokenAction, createGitlabProjectVariableAction, createGitlabRepoPushAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createTriggerGitlabPipelineAction, gitlabModule as default, editGitlabIssueAction };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-scaffolder-backend-module-gitlab",
3
- "version": "0.4.1-next.0",
3
+ "version": "0.4.1-next.2",
4
4
  "backstage": {
5
5
  "role": "backend-plugin-module"
6
6
  },
@@ -40,12 +40,12 @@
40
40
  "test": "backstage-cli package test"
41
41
  },
42
42
  "dependencies": {
43
- "@backstage/backend-common": "^0.22.1-next.0",
44
- "@backstage/backend-plugin-api": "^0.6.19-next.0",
43
+ "@backstage/backend-common": "^0.23.0-next.2",
44
+ "@backstage/backend-plugin-api": "^0.6.19-next.2",
45
45
  "@backstage/config": "^1.2.0",
46
46
  "@backstage/errors": "^1.2.4",
47
- "@backstage/integration": "^1.11.0",
48
- "@backstage/plugin-scaffolder-node": "^0.4.5-next.0",
47
+ "@backstage/integration": "^1.12.0-next.0",
48
+ "@backstage/plugin-scaffolder-node": "^0.4.5-next.2",
49
49
  "@gitbeaker/core": "^35.8.0",
50
50
  "@gitbeaker/node": "^35.8.0",
51
51
  "@gitbeaker/rest": "^39.25.0",
@@ -54,9 +54,9 @@
54
54
  "zod": "^3.22.4"
55
55
  },
56
56
  "devDependencies": {
57
- "@backstage/backend-test-utils": "^0.3.9-next.0",
58
- "@backstage/cli": "^0.26.6-next.0",
59
- "@backstage/core-app-api": "^1.12.5",
60
- "@backstage/plugin-scaffolder-node-test-utils": "^0.1.5-next.0"
57
+ "@backstage/backend-test-utils": "^0.4.0-next.2",
58
+ "@backstage/cli": "^0.26.7-next.2",
59
+ "@backstage/core-app-api": "^1.12.6-next.0",
60
+ "@backstage/plugin-scaffolder-node-test-utils": "^0.1.5-next.2"
61
61
  }
62
62
  }