pcit-github-release/metadata.json at master · pcit-plugins/pcit-github-release · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
{
    "title": "JSON schema for configuring PCIT CI/CD plugin",
    "$schema": "http://json-schema.org/draft-07/schema",
    "$id": "pcit/github-release",
    "$comment": "https://docs.ci.khs1994.com/usage/",
    "description": "The github-release plugin is used to publish files and artifacts to GitHub Release.",
    "github": "https://github.com/pcit-plugins/pcit-github-release",
    "tags": "Release",
    "author": "PCIT",
    "properties": {
        "token": {
            "type": "string",
            "description": "GitHub oauth token with public_repo or repo permission, see https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/",
            "default": " ${GITHUB_TOKEN}"
        },
        "repo": {
            "type": "string",
            "description": "github repository name"
        },
        "files": {
            "type": "array",
            "uniqueItems": true,
            "description": "files to upload to GitHub Release, globs are allowed",
            "items": {
                "type": "string"
            },
            "minItems": 1,
            "default": " dist/*",
            "examples": [
                "dist/*",
                "bin/binary.exe"
            ]
        },
        "checksum": {
            "type": "array",
            "uniqueItems": true,
            "minItems": 1,
            "description": "checksum takes hash methods to include in your GitHub release for the files specified.",
            "items": {
                "enum": [
                    "md5",
                    "sha1",
                    "sha256",
                    "sha512",
                    "adler32",
                    "crc32"
                ]
            },
            "default": [
                [
                    "sha256"
                ]
            ]
        },
        "checksum_file": {
            "type": "string",
            "description": "name used for checksum file. \"CHECKSUM\" is replaced with the chosen method",
            "default": " CHECKSUMsum.txt"
        },
        "checksum_flatten": {
            "type": "boolean",
            "description": "include only the basename of the file in the checksum file",
            "default": false
        },
        "draft": {
            "type": "boolean",
            "description": "create a draft release if set to true",
            "default": false
        },
        "prerelease": {
            "type": "boolean",
            "description": "set the release as prerelease if set to true",
            "default": false
        },
        "file_exists": {
            "type": "string",
            "description": "what to do if an file asset already exists",
            "enum": [
                "overwrite",
                "skip",
                "fail"
            ],
            "default": " overwrite"
        },
        "target_commitish": {
            "type": "string",
            "description": "target commitish",
            "examples": [
                "refs/tags/nightly"
            ]
        },
        "note": {
            "type": "string",
            "description": "file or string with notes for the release, see https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release"
        },
        "title": {
            "type": "string",
            "description": "file or string for the title shown in the github release, see https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release"
        },
        "overwrite": {
            "type": "boolean",
            "description": "force overwrite existing release informations (only title and note)",
            "default": false
        }
    },
    "required": [
        "token",
        "files"
    ]
}