@backstage-community/plugin-scaffolder-backend-module-quay 2.9.1 → 2.10.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/CHANGELOG.md
CHANGED
|
@@ -29,55 +29,24 @@ function createQuayRepositoryAction() {
|
|
|
29
29
|
description: "Create an quay image repository",
|
|
30
30
|
schema: {
|
|
31
31
|
input: {
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
description: "The repository desription",
|
|
48
|
-
type: "string"
|
|
49
|
-
},
|
|
50
|
-
token: {
|
|
51
|
-
title: "Token",
|
|
52
|
-
description: "Bearer token used for authorization",
|
|
53
|
-
type: "string"
|
|
54
|
-
},
|
|
55
|
-
baseUrl: {
|
|
56
|
-
title: "Base URL",
|
|
57
|
-
description: 'URL of your quay instance, set to "https://quay.io" by default',
|
|
58
|
-
type: "string"
|
|
59
|
-
},
|
|
60
|
-
namespace: {
|
|
61
|
-
title: "Namespace",
|
|
62
|
-
description: "Namespace in which to create the repository, by default the users namespace",
|
|
63
|
-
type: "string"
|
|
64
|
-
},
|
|
65
|
-
repoKind: {
|
|
66
|
-
title: "Repository kind",
|
|
67
|
-
description: "The crated repository type either image or an application, if empty image will be used",
|
|
68
|
-
type: "string"
|
|
69
|
-
}
|
|
70
|
-
}
|
|
32
|
+
name: (z) => z.string().describe("Name of the repository to be created"),
|
|
33
|
+
visibility: (z) => z.string().describe(
|
|
34
|
+
"Visibility setting for the created repository, either public or private"
|
|
35
|
+
),
|
|
36
|
+
description: (z) => z.string().describe("The repository description"),
|
|
37
|
+
token: (z) => z.string().describe("Bearer token used for authorization"),
|
|
38
|
+
baseUrl: (z) => z.string().optional().describe(
|
|
39
|
+
'URL of your quay instance, set to "https://quay.io" by default'
|
|
40
|
+
),
|
|
41
|
+
namespace: (z) => z.string().optional().describe(
|
|
42
|
+
"Namespace in which to create the repository, by default the users namespace"
|
|
43
|
+
),
|
|
44
|
+
repoKind: (z) => z.string().optional().describe(
|
|
45
|
+
"The created repository type either image or an application, if empty image will be used"
|
|
46
|
+
)
|
|
71
47
|
},
|
|
72
48
|
output: {
|
|
73
|
-
|
|
74
|
-
properties: {
|
|
75
|
-
repositoryUrl: {
|
|
76
|
-
title: "Quay image repository URL",
|
|
77
|
-
type: "string",
|
|
78
|
-
description: "Created repository URL link"
|
|
79
|
-
}
|
|
80
|
-
}
|
|
49
|
+
repositoryUrl: (z) => z.string().describe("Created repository URL link")
|
|
81
50
|
}
|
|
82
51
|
},
|
|
83
52
|
async handler(ctx) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createQuayRepository.cjs.js","sources":["../../src/actions/createQuayRepository.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\n\nimport { examples } from './quay-actions.examples';\n\nexport interface ResponseBody {\n namespace: string;\n name: string;\n kind: string;\n}\nexport interface ResponseErrorBody {\n detail: string;\n error_message: string;\n error_type: string;\n title: string;\n type: string;\n status: number;\n}\ninterface RequestBody {\n repository: string;\n visibility: string;\n namespace?: string;\n description: string;\n repo_kind?: string;\n}\n\n/**\n * @public\n */\nexport type TemplateActionParameters = {\n name: string;\n visibility: string;\n description: string;\n token: string;\n baseUrl?: string;\n namespace?: string;\n repoKind?: string;\n};\n\nconst getUrl = (url: string | undefined): string => {\n if (!url) {\n return 'https://quay.io';\n }\n try {\n // eslint-disable-next-line no-new\n new URL(url);\n } catch (error) {\n throw new Error('\"baseUrl\" is invalid');\n }\n return url;\n};\n\nconst isValueValid = (\n value: string | undefined,\n valueName: string,\n valueOpts: Array<string | undefined>,\n) => {\n if (valueOpts.includes(value)) {\n return;\n }\n throw new Error(\n `For the \"${valueName}\" parameter \"${value}\" is not a valid option,` +\n ` available options are: ${valueOpts.map(v => v || 'none').join(', ')}`,\n );\n};\n\n/**\n * @public\n */\nexport function createQuayRepositoryAction() {\n return createTemplateAction
|
|
1
|
+
{"version":3,"file":"createQuayRepository.cjs.js","sources":["../../src/actions/createQuayRepository.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\n\nimport { examples } from './quay-actions.examples';\n\nexport interface ResponseBody {\n namespace: string;\n name: string;\n kind: string;\n}\nexport interface ResponseErrorBody {\n detail: string;\n error_message: string;\n error_type: string;\n title: string;\n type: string;\n status: number;\n}\ninterface RequestBody {\n repository: string;\n visibility: string;\n namespace?: string;\n description: string;\n repo_kind?: string;\n}\n\n/**\n * @public\n */\nexport type TemplateActionParameters = {\n name: string;\n visibility: string;\n description: string;\n token: string;\n baseUrl?: string;\n namespace?: string;\n repoKind?: string;\n};\n\nconst getUrl = (url: string | undefined): string => {\n if (!url) {\n return 'https://quay.io';\n }\n try {\n // eslint-disable-next-line no-new\n new URL(url);\n } catch (error) {\n throw new Error('\"baseUrl\" is invalid');\n }\n return url;\n};\n\nconst isValueValid = (\n value: string | undefined,\n valueName: string,\n valueOpts: Array<string | undefined>,\n) => {\n if (valueOpts.includes(value)) {\n return;\n }\n throw new Error(\n `For the \"${valueName}\" parameter \"${value}\" is not a valid option,` +\n ` available options are: ${valueOpts.map(v => v || 'none').join(', ')}`,\n );\n};\n\n/**\n * @public\n */\nexport function createQuayRepositoryAction() {\n return createTemplateAction({\n id: 'quay:create-repository',\n examples,\n description: 'Create an quay image repository',\n schema: {\n input: {\n name: z => z.string().describe('Name of the repository to be created'),\n visibility: z =>\n z\n .string()\n .describe(\n 'Visibility setting for the created repository, either public or private',\n ),\n description: z => z.string().describe('The repository description'),\n token: z => z.string().describe('Bearer token used for authorization'),\n baseUrl: z =>\n z\n .string()\n .optional()\n .describe(\n 'URL of your quay instance, set to \"https://quay.io\" by default',\n ),\n namespace: z =>\n z\n .string()\n .optional()\n .describe(\n 'Namespace in which to create the repository, by default the users namespace',\n ),\n repoKind: z =>\n z\n .string()\n .optional()\n .describe(\n 'The created repository type either image or an application, if empty image will be used',\n ),\n },\n output: {\n repositoryUrl: z => z.string().describe('Created repository URL link'),\n },\n },\n async handler(ctx) {\n const { token, name, visibility, namespace, description, repoKind } =\n ctx.input;\n const baseUrl = getUrl(ctx.input.baseUrl);\n isValueValid(visibility, 'visibility', ['public', 'private']);\n isValueValid(repoKind, 'repository kind', [\n 'application',\n 'image',\n undefined,\n ]);\n\n const params: RequestBody = {\n description,\n repository: name,\n visibility,\n namespace,\n repo_kind: repoKind,\n };\n\n const uri = encodeURI(`${baseUrl}/api/v1/repository`);\n const response = await fetch(uri, {\n headers: {\n 'Content-Type': 'application/json',\n Accept: 'application/json',\n Authorization: `Bearer ${token}`,\n },\n body: JSON.stringify(params),\n method: 'POST',\n });\n\n if (!response.ok) {\n const errorBody = (await response.json()) as ResponseErrorBody;\n const errorStatus = errorBody.status || response.status;\n // Some error responses don't have the structure defined in ResponseErrorBody\n const errorMsg = errorBody.detail || (errorBody as any).error;\n throw new Error(\n `Failed to create Quay repository, ${errorStatus} -- ${errorMsg}`,\n );\n }\n\n const body = (await response.json()) as ResponseBody;\n ctx.output(\n 'repositoryUrl',\n `${baseUrl}/repository/${body.namespace}/${body.name}`,\n );\n },\n });\n}\n"],"names":["createTemplateAction","examples"],"mappings":";;;;;AAqDA,MAAM,MAAA,GAAS,CAAC,GAAoC,KAAA;AAClD,EAAA,IAAI,CAAC,GAAK,EAAA;AACR,IAAO,OAAA,iBAAA;AAAA;AAET,EAAI,IAAA;AAEF,IAAA,IAAI,IAAI,GAAG,CAAA;AAAA,WACJ,KAAO,EAAA;AACd,IAAM,MAAA,IAAI,MAAM,sBAAsB,CAAA;AAAA;AAExC,EAAO,OAAA,GAAA;AACT,CAAA;AAEA,MAAM,YAAe,GAAA,CACnB,KACA,EAAA,SAAA,EACA,SACG,KAAA;AACH,EAAI,IAAA,SAAA,CAAU,QAAS,CAAA,KAAK,CAAG,EAAA;AAC7B,IAAA;AAAA;AAEF,EAAA,MAAM,IAAI,KAAA;AAAA,IACR,CAAY,SAAA,EAAA,SAAS,CAAgB,aAAA,EAAA,KAAK,CACb,gDAAA,EAAA,SAAA,CAAU,GAAI,CAAA,CAAA,CAAA,KAAK,CAAK,IAAA,MAAM,CAAE,CAAA,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,GACzE;AACF,CAAA;AAKO,SAAS,0BAA6B,GAAA;AAC3C,EAAA,OAAOA,yCAAqB,CAAA;AAAA,IAC1B,EAAI,EAAA,wBAAA;AAAA,cACJC,6BAAA;AAAA,IACA,WAAa,EAAA,iCAAA;AAAA,IACb,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,MAAM,CAAK,CAAA,KAAA,CAAA,CAAE,MAAO,EAAA,CAAE,SAAS,sCAAsC,CAAA;AAAA,QACrE,UAAY,EAAA,CAAA,CAAA,KACV,CACG,CAAA,MAAA,EACA,CAAA,QAAA;AAAA,UACC;AAAA,SACF;AAAA,QACJ,aAAa,CAAK,CAAA,KAAA,CAAA,CAAE,MAAO,EAAA,CAAE,SAAS,4BAA4B,CAAA;AAAA,QAClE,OAAO,CAAK,CAAA,KAAA,CAAA,CAAE,MAAO,EAAA,CAAE,SAAS,qCAAqC,CAAA;AAAA,QACrE,SAAS,CACP,CAAA,KAAA,CAAA,CACG,MAAO,EAAA,CACP,UACA,CAAA,QAAA;AAAA,UACC;AAAA,SACF;AAAA,QACJ,WAAW,CACT,CAAA,KAAA,CAAA,CACG,MAAO,EAAA,CACP,UACA,CAAA,QAAA;AAAA,UACC;AAAA,SACF;AAAA,QACJ,UAAU,CACR,CAAA,KAAA,CAAA,CACG,MAAO,EAAA,CACP,UACA,CAAA,QAAA;AAAA,UACC;AAAA;AACF,OACN;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,eAAe,CAAK,CAAA,KAAA,CAAA,CAAE,MAAO,EAAA,CAAE,SAAS,6BAA6B;AAAA;AACvE,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA,EAAE,OAAO,IAAM,EAAA,UAAA,EAAY,WAAW,WAAa,EAAA,QAAA,KACvD,GAAI,CAAA,KAAA;AACN,MAAA,MAAM,OAAU,GAAA,MAAA,CAAO,GAAI,CAAA,KAAA,CAAM,OAAO,CAAA;AACxC,MAAA,YAAA,CAAa,UAAY,EAAA,YAAA,EAAc,CAAC,QAAA,EAAU,SAAS,CAAC,CAAA;AAC5D,MAAA,YAAA,CAAa,UAAU,iBAAmB,EAAA;AAAA,QACxC,aAAA;AAAA,QACA,OAAA;AAAA,QACA;AAAA,OACD,CAAA;AAED,MAAA,MAAM,MAAsB,GAAA;AAAA,QAC1B,WAAA;AAAA,QACA,UAAY,EAAA,IAAA;AAAA,QACZ,UAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAW,EAAA;AAAA,OACb;AAEA,MAAA,MAAM,GAAM,GAAA,SAAA,CAAU,CAAG,EAAA,OAAO,CAAoB,kBAAA,CAAA,CAAA;AACpD,MAAM,MAAA,QAAA,GAAW,MAAM,KAAA,CAAM,GAAK,EAAA;AAAA,QAChC,OAAS,EAAA;AAAA,UACP,cAAgB,EAAA,kBAAA;AAAA,UAChB,MAAQ,EAAA,kBAAA;AAAA,UACR,aAAA,EAAe,UAAU,KAAK,CAAA;AAAA,SAChC;AAAA,QACA,IAAA,EAAM,IAAK,CAAA,SAAA,CAAU,MAAM,CAAA;AAAA,QAC3B,MAAQ,EAAA;AAAA,OACT,CAAA;AAED,MAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,QAAM,MAAA,SAAA,GAAa,MAAM,QAAA,CAAS,IAAK,EAAA;AACvC,QAAM,MAAA,WAAA,GAAc,SAAU,CAAA,MAAA,IAAU,QAAS,CAAA,MAAA;AAEjD,QAAM,MAAA,QAAA,GAAW,SAAU,CAAA,MAAA,IAAW,SAAkB,CAAA,KAAA;AACxD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,kCAAA,EAAqC,WAAW,CAAA,IAAA,EAAO,QAAQ,CAAA;AAAA,SACjE;AAAA;AAGF,MAAM,MAAA,IAAA,GAAQ,MAAM,QAAA,CAAS,IAAK,EAAA;AAClC,MAAI,GAAA,CAAA,MAAA;AAAA,QACF,eAAA;AAAA,QACA,GAAG,OAAO,CAAA,YAAA,EAAe,KAAK,SAAS,CAAA,CAAA,EAAI,KAAK,IAAI,CAAA;AAAA,OACtD;AAAA;AACF,GACD,CAAA;AACH;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
|
|
2
|
-
import * as _backstage_types_index from '@backstage/types/index';
|
|
3
2
|
import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
|
|
4
3
|
|
|
5
4
|
/**
|
|
@@ -17,7 +16,17 @@ type TemplateActionParameters = {
|
|
|
17
16
|
/**
|
|
18
17
|
* @public
|
|
19
18
|
*/
|
|
20
|
-
declare function createQuayRepositoryAction(): _backstage_plugin_scaffolder_node.TemplateAction<
|
|
19
|
+
declare function createQuayRepositoryAction(): _backstage_plugin_scaffolder_node.TemplateAction<{
|
|
20
|
+
name: string;
|
|
21
|
+
visibility: string;
|
|
22
|
+
description: string;
|
|
23
|
+
token: string;
|
|
24
|
+
baseUrl?: string | undefined;
|
|
25
|
+
namespace?: string | undefined;
|
|
26
|
+
repoKind?: string | undefined;
|
|
27
|
+
}, {
|
|
28
|
+
repositoryUrl: string;
|
|
29
|
+
}, "v2">;
|
|
21
30
|
|
|
22
31
|
/**
|
|
23
32
|
* @public
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage-community/plugin-scaffolder-backend-module-quay",
|
|
3
3
|
"description": "The quay-actions module for @backstage-community/plugin-scaffolder-backend-module-quay",
|
|
4
|
-
"version": "2.
|
|
4
|
+
"version": "2.10.0",
|
|
5
5
|
"main": "./dist/index.cjs.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -46,13 +46,13 @@
|
|
|
46
46
|
"prettier:fix": "prettier --ignore-unknown --write ."
|
|
47
47
|
},
|
|
48
48
|
"dependencies": {
|
|
49
|
-
"@backstage/backend-plugin-api": "^1.
|
|
50
|
-
"@backstage/plugin-scaffolder-node": "^0.
|
|
49
|
+
"@backstage/backend-plugin-api": "^1.4.1",
|
|
50
|
+
"@backstage/plugin-scaffolder-node": "^0.10.0",
|
|
51
51
|
"yaml": "^2.6.0"
|
|
52
52
|
},
|
|
53
53
|
"devDependencies": {
|
|
54
|
-
"@backstage/cli": "^0.
|
|
55
|
-
"@backstage/plugin-scaffolder-node-test-utils": "^0.
|
|
54
|
+
"@backstage/cli": "^0.33.1",
|
|
55
|
+
"@backstage/plugin-scaffolder-node-test-utils": "^0.3.1"
|
|
56
56
|
},
|
|
57
57
|
"files": [
|
|
58
58
|
"dist"
|