@simple-release/github-action 2.2.0 → 3.0.1
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/README.md +92 -4
- package/dist/comment.js +1 -1
- package/dist/conditions.js +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/options.d.ts +23 -0
- package/dist/options.d.ts.map +1 -0
- package/dist/options.js +43 -0
- package/dist/releaser.d.ts +5 -0
- package/dist/releaser.d.ts.map +1 -1
- package/dist/releaser.js +24 -3
- package/package.json +7 -6
package/README.md
CHANGED
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
[node-url]: https://nodejs.org
|
|
19
19
|
|
|
20
20
|
[deps]: https://img.shields.io/librariesio/release/npm/@simple-release/github-action
|
|
21
|
-
[deps-url]: https://libraries.io/npm/@simple-release%2Fgithub-actions
|
|
21
|
+
[deps-url]: https://libraries.io/npm/@simple-release%2Fgithub-actions
|
|
22
22
|
|
|
23
23
|
[size]: https://packagephobia.com/badge?p=@simple-release/github-action
|
|
24
24
|
[size-url]: https://packagephobia.com/result?p=@simple-release/github-action
|
|
@@ -47,7 +47,11 @@ npm i @simple-release/github-action
|
|
|
47
47
|
```js
|
|
48
48
|
import { getOctokit } from '@actions/github'
|
|
49
49
|
import { load } from '@simple-release/config'
|
|
50
|
-
import {
|
|
50
|
+
import {
|
|
51
|
+
ReleaserGithubAction,
|
|
52
|
+
getInputOptions,
|
|
53
|
+
ifReleaseCommit
|
|
54
|
+
} from '@simple-release/github-action'
|
|
51
55
|
|
|
52
56
|
const {
|
|
53
57
|
project,
|
|
@@ -79,8 +83,8 @@ action
|
|
|
79
83
|
.setOptions(options)
|
|
80
84
|
.tag()
|
|
81
85
|
.push()
|
|
82
|
-
.release()
|
|
83
86
|
.publish()
|
|
87
|
+
.release()
|
|
84
88
|
.run(ifReleaseCommit)
|
|
85
89
|
|
|
86
90
|
// Run all steps to create a pull request with version bump
|
|
@@ -93,13 +97,33 @@ action
|
|
|
93
97
|
.setOptions(options)
|
|
94
98
|
.runReleaseAction()
|
|
95
99
|
|
|
100
|
+
// Run all steps to publish a snapshot version
|
|
101
|
+
action
|
|
102
|
+
.setOptions(options)
|
|
103
|
+
.runSnapshotAction('canary')
|
|
104
|
+
|
|
96
105
|
// Detect action by commit type and run appropriate steps
|
|
97
106
|
action
|
|
98
107
|
.setOptions(options)
|
|
99
108
|
.runAction()
|
|
109
|
+
|
|
110
|
+
// Read supported GitHub Action inputs
|
|
111
|
+
const inputOptions = getInputOptions()
|
|
100
112
|
```
|
|
101
113
|
|
|
102
|
-
|
|
114
|
+
## API
|
|
115
|
+
|
|
116
|
+
### Action helpers
|
|
117
|
+
|
|
118
|
+
| Helper | Description |
|
|
119
|
+
| --- | --- |
|
|
120
|
+
| `fetchOptions` | Read extra releaser options from pull request comments. |
|
|
121
|
+
| `runPullRequestAction` | Run the default pull request flow. |
|
|
122
|
+
| `runReleaseAction` | Run the default release flow. |
|
|
123
|
+
| `runSnapshotAction` | Publish a temporary snapshot version. |
|
|
124
|
+
| `runAction` | Detect current GitHub event context and run pull request or release flow. |
|
|
125
|
+
|
|
126
|
+
#### fetchOptions
|
|
103
127
|
|
|
104
128
|
You can pass additional options to releaser via comment in your pull request. Your comment should start with `!simple-release/set-options` and contain JSON object with options. For example:
|
|
105
129
|
|
|
@@ -116,3 +140,67 @@ You can pass additional options to releaser via comment in your pull request. Yo
|
|
|
116
140
|
````
|
|
117
141
|
|
|
118
142
|
To fetch and parse comments you should use `fetchOptions` step after `checkout` step.
|
|
143
|
+
|
|
144
|
+
#### Default flows
|
|
145
|
+
|
|
146
|
+
`runPullRequestAction` runs:
|
|
147
|
+
|
|
148
|
+
```js
|
|
149
|
+
action
|
|
150
|
+
.checkout()
|
|
151
|
+
.fetchOptions()
|
|
152
|
+
.bump()
|
|
153
|
+
.commit()
|
|
154
|
+
.push()
|
|
155
|
+
.pullRequest()
|
|
156
|
+
.run()
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
`runReleaseAction` runs release steps in an order that lets project-specific `publish` implementations prepare final release artifacts before the GitHub release is created:
|
|
160
|
+
|
|
161
|
+
```js
|
|
162
|
+
action
|
|
163
|
+
.maintenanceBranch()
|
|
164
|
+
.tag()
|
|
165
|
+
.push()
|
|
166
|
+
.publish()
|
|
167
|
+
.release()
|
|
168
|
+
.run(ifReleaseCommit)
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
`maintenanceBranch` is disabled by default. It can be enabled through `setOptions`, pull request comments, or action inputs.
|
|
172
|
+
|
|
173
|
+
`runSnapshotAction(snapshotTag)` publishes a temporary snapshot version. It bumps with a timestamped prerelease identifier, skips changelog generation, publishes with `tag: snapshotTag`, then reverts the version updates.
|
|
174
|
+
|
|
175
|
+
```js
|
|
176
|
+
action
|
|
177
|
+
.bump({
|
|
178
|
+
snapshot: snapshotTag,
|
|
179
|
+
skipChangelog: true
|
|
180
|
+
})
|
|
181
|
+
.publish({
|
|
182
|
+
tag: snapshotTag,
|
|
183
|
+
gitChecks: false
|
|
184
|
+
})
|
|
185
|
+
.revert()
|
|
186
|
+
.run()
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### Input options
|
|
190
|
+
|
|
191
|
+
`getInputOptions` reads GitHub Action inputs and maps them to releaser step options.
|
|
192
|
+
|
|
193
|
+
| Input | Target option |
|
|
194
|
+
| --- | --- |
|
|
195
|
+
| `branch` | `checkout.branch` |
|
|
196
|
+
| `bump-version` | `bump.version` |
|
|
197
|
+
| `bump-as` | `bump.as` |
|
|
198
|
+
| `bump-prerelease` | `bump.prerelease` |
|
|
199
|
+
| `bump-snapshot` | `bump.snapshot` |
|
|
200
|
+
| `bump-first-release` | `bump.firstRelease` |
|
|
201
|
+
| `bump-skip` | `bump.skip` |
|
|
202
|
+
| `bump-by-project` | `bump.byProject` |
|
|
203
|
+
| `maintenance-branch` | `maintenanceBranch.enabled` |
|
|
204
|
+
| `publish-skip` | `publish.skip` |
|
|
205
|
+
| `publish-access` | `publish.access` |
|
|
206
|
+
| `publish-tag` | `publish.tag` |
|
package/dist/comment.js
CHANGED
|
@@ -19,4 +19,4 @@ export function parseSetOptionsComment(comment) {
|
|
|
19
19
|
}
|
|
20
20
|
return null;
|
|
21
21
|
}
|
|
22
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
22
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWVudC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9jb21tZW50LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUtBLE1BQU0sMkJBQTJCLEdBQUc7SUFDbEMsT0FBTztJQUNQLGNBQWM7SUFDZCxRQUFRO0NBQ1QsQ0FBQTtBQUNELE1BQU0sVUFBVSxHQUFHLFNBQVMsQ0FBQTtBQUM1QixNQUFNLGlCQUFpQixHQUFHLFVBQVUsQ0FBQyxNQUFNLENBQUE7QUFDM0MsTUFBTSxRQUFRLEdBQUcsS0FBSyxDQUFBO0FBRXRCLE1BQU0sQ0FBQyxNQUFNLGtCQUFrQixHQUFHLDZCQUE2QixDQUFBO0FBRS9ELE1BQU0sVUFBVSxzQkFBc0IsQ0FBQyxPQUFnQjtJQUNyRCxJQUFJLDJCQUEyQixDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUMsa0JBQWtCLENBQUMsRUFBRSxDQUFDO1FBQ3JFLE1BQU0sRUFBRSxJQUFJLEVBQUUsR0FBRyxPQUFPLENBQUE7UUFFeEIsSUFBSSxJQUFJLEVBQUUsVUFBVSxDQUFDLGtCQUFrQixDQUFDLEVBQUUsQ0FBQztZQUN6QyxNQUFNLEtBQUssR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxDQUFBO1lBQ3RDLE1BQU0sR0FBRyxHQUFHLElBQUksQ0FBQyxXQUFXLENBQUMsUUFBUSxDQUFDLENBQUE7WUFDdEMsTUFBTSxJQUFJLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxLQUFLLEdBQUcsaUJBQWlCLEVBQUUsR0FBRyxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUE7WUFFbEUsT0FBTyxJQUFJLENBQUE7UUFDYixDQUFDO0lBQ0gsQ0FBQztJQUVELE9BQU8sSUFBSSxDQUFBO0FBQ2IsQ0FBQyJ9
|
package/dist/conditions.js
CHANGED
|
@@ -28,4 +28,4 @@ export function ifSetOptionsComment() {
|
|
|
28
28
|
}
|
|
29
29
|
return null; // continue
|
|
30
30
|
}
|
|
31
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
31
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZGl0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9jb25kaXRpb25zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQTtBQUV6QyxPQUFPLEVBQUUsa0JBQWtCLEVBQUUsTUFBTSxjQUFjLENBQUE7QUFFakQsTUFBTSxDQUFDLEtBQUssVUFBVSxlQUFlLENBQUMsUUFBOEI7SUFDbEUsTUFBTSxFQUNKLFNBQVMsRUFDVCxPQUFPLEVBQ1IsR0FBRyxRQUFRLENBQUE7SUFDWixNQUFNLE9BQU8sR0FBRyxNQUFNLFNBQVMsQ0FBQyxJQUFJLENBQUMsS0FBSyxFQUFFLElBQUksRUFBRSxhQUFhLENBQUMsQ0FBQTtJQUNoRSxNQUFNLElBQUksR0FBRyxNQUFNLE9BQU8sQ0FBQyxPQUFPLEVBQUUsQ0FBQTtJQUVwQyxPQUFPLElBQUksQ0FBQyxNQUFNLEdBQUcsQ0FBQyxJQUFJLE9BQU8sQ0FBQyxVQUFVLENBQUMsaUJBQWlCLENBQUMsQ0FBQTtBQUNqRSxDQUFDO0FBRUQsTUFBTSxVQUFVLG1CQUFtQjtJQUNqQyxNQUFNLEVBQ0osU0FBUyxFQUNULE9BQU8sRUFBRSxFQUNQLEtBQUssRUFDTCxPQUFPLEVBQ1IsRUFDRixHQUFHLE9BQU8sQ0FBQTtJQUNYLE1BQU0sYUFBYSxHQUFHLEtBQUssRUFBRSxZQUF1QixDQUFBO0lBQ3BELE1BQU0sV0FBVyxHQUFJLEtBQUssRUFBRSxJQUFzQyxFQUFFLEtBQUssQ0FBQTtJQUN6RSxNQUFNLFNBQVMsR0FBRyxLQUFLLEVBQUUsSUFBSSxDQUFBO0lBQzdCLE1BQU0sVUFBVSxHQUFHLEtBQUssRUFBRSxLQUFlLENBQUE7SUFDekMsTUFBTSxXQUFXLEdBQUksT0FBeUMsRUFBRSxJQUFJLENBQUE7SUFFcEUsSUFBSSxTQUFTLEtBQUssZUFBZSxFQUFFLENBQUM7UUFDbEMsSUFBSSxhQUFhO2VBQ1osV0FBVyxLQUFLLHFCQUFxQjtlQUNyQyxVQUFVLEtBQUssTUFBTTtlQUNyQixTQUFTLEVBQUUsUUFBUSxDQUFDLG1DQUFtQyxDQUFDO2VBQ3hELFdBQVcsRUFBRSxRQUFRLENBQUMsa0JBQWtCLENBQUMsRUFDNUMsQ0FBQztZQUNELE1BQU0sT0FBTyxHQUFHLFNBQVMsQ0FBQyxLQUFLLENBQUMsc0NBQXNDLENBQUMsQ0FBQTtZQUV2RSxJQUFJLE9BQU8sRUFBRSxDQUFDO2dCQUNaLE9BQU8sT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFBO1lBQ25CLENBQUM7UUFDSCxDQUFDO1FBRUQsT0FBTyxLQUFLLENBQUEsQ0FBQywwQ0FBMEM7SUFDekQsQ0FBQztJQUVELE9BQU8sSUFBSSxDQUFBLENBQUMsV0FBVztBQUN6QixDQUFDIn0=
|
package/dist/index.d.ts
CHANGED
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,cAAc,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
1
|
export * from './releaser.js';
|
|
2
2
|
export * from './conditions.js';
|
|
3
|
-
|
|
3
|
+
export * from './options.js';
|
|
4
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxlQUFlLENBQUE7QUFDN0IsY0FBYyxpQkFBaUIsQ0FBQTtBQUMvQixjQUFjLGNBQWMsQ0FBQSJ9
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
export declare function getInputOptions(): {
|
|
2
|
+
checkout: Partial<{
|
|
3
|
+
branch: string;
|
|
4
|
+
}>;
|
|
5
|
+
bump: Partial<{
|
|
6
|
+
version: string;
|
|
7
|
+
as: string;
|
|
8
|
+
prerelease: string;
|
|
9
|
+
snapshot: string;
|
|
10
|
+
firstRelease: boolean | undefined;
|
|
11
|
+
skip: boolean | undefined;
|
|
12
|
+
byProject: {} | undefined;
|
|
13
|
+
}>;
|
|
14
|
+
maintenanceBranch: Partial<{
|
|
15
|
+
enabled: boolean | undefined;
|
|
16
|
+
}>;
|
|
17
|
+
publish: Partial<{
|
|
18
|
+
skip: boolean | undefined;
|
|
19
|
+
access: string;
|
|
20
|
+
tag: string;
|
|
21
|
+
}>;
|
|
22
|
+
};
|
|
23
|
+
//# sourceMappingURL=options.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AA4BA,wBAAgB,eAAe;IAE3B,QAAQ;;;IAGR,IAAI;;;;;;;;;IASJ,iBAAiB;;;IAGjB,OAAO;;;;;EAMV"}
|
package/dist/options.js
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { getBooleanInput, getInput } from '@actions/core';
|
|
2
|
+
function omitEmpty(object) {
|
|
3
|
+
const result = {};
|
|
4
|
+
for (const [key, value] of Object.entries(object)) {
|
|
5
|
+
if (typeof value === 'boolean' || Boolean(value)) {
|
|
6
|
+
result[key] = value;
|
|
7
|
+
}
|
|
8
|
+
}
|
|
9
|
+
return result;
|
|
10
|
+
}
|
|
11
|
+
function getOptionalBooleanInput(name) {
|
|
12
|
+
return getInput(name) ? getBooleanInput(name) : undefined;
|
|
13
|
+
}
|
|
14
|
+
function getOptionalJsonInput(name) {
|
|
15
|
+
const value = getInput(name);
|
|
16
|
+
// oxlint-disable-next-line typescript/no-empty-object-type
|
|
17
|
+
return value ? JSON.parse(value) : undefined;
|
|
18
|
+
}
|
|
19
|
+
export function getInputOptions() {
|
|
20
|
+
return {
|
|
21
|
+
checkout: omitEmpty({
|
|
22
|
+
branch: getInput('branch')
|
|
23
|
+
}),
|
|
24
|
+
bump: omitEmpty({
|
|
25
|
+
version: getInput('bump-version'),
|
|
26
|
+
as: getInput('bump-as'),
|
|
27
|
+
prerelease: getInput('bump-prerelease'),
|
|
28
|
+
snapshot: getInput('bump-snapshot'),
|
|
29
|
+
firstRelease: getOptionalBooleanInput('bump-first-release'),
|
|
30
|
+
skip: getOptionalBooleanInput('bump-skip'),
|
|
31
|
+
byProject: getOptionalJsonInput('bump-by-project')
|
|
32
|
+
}),
|
|
33
|
+
maintenanceBranch: omitEmpty({
|
|
34
|
+
enabled: getOptionalBooleanInput('maintenance-branch')
|
|
35
|
+
}),
|
|
36
|
+
publish: omitEmpty({
|
|
37
|
+
skip: getOptionalBooleanInput('publish-skip'),
|
|
38
|
+
access: getInput('publish-access'),
|
|
39
|
+
tag: getInput('publish-tag')
|
|
40
|
+
})
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3B0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9vcHRpb25zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFDTCxlQUFlLEVBQ2YsUUFBUSxFQUNULE1BQU0sZUFBZSxDQUFBO0FBRXRCLFNBQVMsU0FBUyxDQUFtQixNQUFTO0lBQzVDLE1BQU0sTUFBTSxHQUFHLEVBQWdCLENBQUE7SUFFL0IsS0FBSyxNQUFNLENBQUMsR0FBRyxFQUFFLEtBQUssQ0FBQyxJQUFJLE1BQU0sQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQztRQUNsRCxJQUFJLE9BQU8sS0FBSyxLQUFLLFNBQVMsSUFBSSxPQUFPLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztZQUNqRCxNQUFNLENBQUMsR0FBYyxDQUFDLEdBQUcsS0FBbUIsQ0FBQTtRQUM5QyxDQUFDO0lBQ0gsQ0FBQztJQUVELE9BQU8sTUFBTSxDQUFBO0FBQ2YsQ0FBQztBQUVELFNBQVMsdUJBQXVCLENBQUMsSUFBWTtJQUMzQyxPQUFPLFFBQVEsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsZUFBZSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUE7QUFDM0QsQ0FBQztBQUVELFNBQVMsb0JBQW9CLENBQUMsSUFBWTtJQUN4QyxNQUFNLEtBQUssR0FBRyxRQUFRLENBQUMsSUFBSSxDQUFDLENBQUE7SUFFNUIsMkRBQTJEO0lBQzNELE9BQU8sS0FBSyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBTyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUE7QUFDcEQsQ0FBQztBQUVELE1BQU0sVUFBVSxlQUFlO0lBQzdCLE9BQU87UUFDTCxRQUFRLEVBQUUsU0FBUyxDQUFDO1lBQ2xCLE1BQU0sRUFBRSxRQUFRLENBQUMsUUFBUSxDQUFDO1NBQzNCLENBQUM7UUFDRixJQUFJLEVBQUUsU0FBUyxDQUFDO1lBQ2QsT0FBTyxFQUFFLFFBQVEsQ0FBQyxjQUFjLENBQUM7WUFDakMsRUFBRSxFQUFFLFFBQVEsQ0FBQyxTQUFTLENBQUM7WUFDdkIsVUFBVSxFQUFFLFFBQVEsQ0FBQyxpQkFBaUIsQ0FBQztZQUN2QyxRQUFRLEVBQUUsUUFBUSxDQUFDLGVBQWUsQ0FBQztZQUNuQyxZQUFZLEVBQUUsdUJBQXVCLENBQUMsb0JBQW9CLENBQUM7WUFDM0QsSUFBSSxFQUFFLHVCQUF1QixDQUFDLFdBQVcsQ0FBQztZQUMxQyxTQUFTLEVBQUUsb0JBQW9CLENBQUMsaUJBQWlCLENBQUM7U0FDbkQsQ0FBQztRQUNGLGlCQUFpQixFQUFFLFNBQVMsQ0FBQztZQUMzQixPQUFPLEVBQUUsdUJBQXVCLENBQUMsb0JBQW9CLENBQUM7U0FDdkQsQ0FBQztRQUNGLE9BQU8sRUFBRSxTQUFTLENBQUM7WUFDakIsSUFBSSxFQUFFLHVCQUF1QixDQUFDLGNBQWMsQ0FBQztZQUM3QyxNQUFNLEVBQUUsUUFBUSxDQUFDLGdCQUFnQixDQUFDO1lBQ2xDLEdBQUcsRUFBRSxRQUFRLENBQUMsYUFBYSxDQUFDO1NBQzdCLENBQUM7S0FDSCxDQUFBO0FBQ0gsQ0FBQyJ9
|
package/dist/releaser.d.ts
CHANGED
|
@@ -27,6 +27,11 @@ export declare class ReleaserGithubAction<P extends Project = Project> extends R
|
|
|
27
27
|
* @param check - Whether to check if the commit is a release commit.
|
|
28
28
|
*/
|
|
29
29
|
runReleaseAction(check?: boolean): Promise<void>;
|
|
30
|
+
/**
|
|
31
|
+
* Run all steps to publish a snapshot version.
|
|
32
|
+
* @param snapshotTag - NPM tag and snapshot pre-release identifier.
|
|
33
|
+
*/
|
|
34
|
+
runSnapshotAction(snapshotTag: string): Promise<void>;
|
|
30
35
|
/**
|
|
31
36
|
* Run action based on the context.
|
|
32
37
|
*/
|
package/dist/releaser.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"releaser.d.ts","sourceRoot":"","sources":["../src/releaser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,
|
|
1
|
+
{"version":3,"file":"releaser.d.ts","sourceRoot":"","sources":["../src/releaser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EAEL,KAAK,OAAO,EACZ,KAAK,eAAe,EACpB,QAAQ,EACT,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAEL,aAAa,EACd,MAAM,wBAAwB,CAAA;AAO/B,MAAM,WAAW,2BAA2B,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,CAAE,SAAQ,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,aAAa,CAAC,EAAE,SAAS,CAAC;IAClI;;OAEG;IACH,OAAO,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;CACvC;AAED,qBAAa,oBAAoB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,CAAE,SAAQ,QAAQ,CAAC,CAAC,EAAE,aAAa,CAAC;IACvF,OAAO,EAAE,aAAa,CAAA;IAE9B,YACE,OAAO,EAAE,2BAA2B,CAAC,CAAC,CAAC,EAQxC;IAEQ,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,QAOhC;IAED;;;OAGG;IACH,YAAY,SAsDX;IAEQ,GAAG,SAIX;IAEQ,IAAI,SAIZ;IAED;;OAEG;IACG,oBAAoB,kBASzB;IAED;;;OAGG;IACG,gBAAgB,CAAC,KAAK,UAAO,iBAQlC;IAED;;;OAGG;IACG,iBAAiB,CAAC,WAAW,EAAE,MAAM,iBAgB1C;IAED;;OAEG;IACG,SAAS,kBAwCd;CACF"}
|
package/dist/releaser.js
CHANGED
|
@@ -55,7 +55,7 @@ export class ReleaserGithubAction extends Releaser {
|
|
|
55
55
|
logger.verbose('fetch-options', json);
|
|
56
56
|
super.setOptions(options);
|
|
57
57
|
}
|
|
58
|
-
catch
|
|
58
|
+
catch {
|
|
59
59
|
logger.verbose('fetch-options', 'Failed to parse parameters comment:');
|
|
60
60
|
logger.verbose('fetch-options', json);
|
|
61
61
|
}
|
|
@@ -93,12 +93,33 @@ export class ReleaserGithubAction extends Releaser {
|
|
|
93
93
|
*/
|
|
94
94
|
async runReleaseAction(check = true) {
|
|
95
95
|
await this
|
|
96
|
+
.maintenanceBranch()
|
|
96
97
|
.tag()
|
|
97
98
|
.push()
|
|
98
|
-
.release()
|
|
99
99
|
.publish()
|
|
100
|
+
.release()
|
|
100
101
|
.run(check ? ifReleaseCommit : undefined);
|
|
101
102
|
}
|
|
103
|
+
/**
|
|
104
|
+
* Run all steps to publish a snapshot version.
|
|
105
|
+
* @param snapshotTag - NPM tag and snapshot pre-release identifier.
|
|
106
|
+
*/
|
|
107
|
+
async runSnapshotAction(snapshotTag) {
|
|
108
|
+
if (!snapshotTag) {
|
|
109
|
+
throw new Error('Snapshot tag is required.');
|
|
110
|
+
}
|
|
111
|
+
await this
|
|
112
|
+
.bump({
|
|
113
|
+
snapshot: snapshotTag,
|
|
114
|
+
skipChangelog: true
|
|
115
|
+
})
|
|
116
|
+
.publish({
|
|
117
|
+
tag: snapshotTag,
|
|
118
|
+
gitChecks: false
|
|
119
|
+
})
|
|
120
|
+
.revert()
|
|
121
|
+
.run();
|
|
122
|
+
}
|
|
102
123
|
/**
|
|
103
124
|
* Run action based on the context.
|
|
104
125
|
*/
|
|
@@ -136,4 +157,4 @@ export class ReleaserGithubAction extends Releaser {
|
|
|
136
157
|
}
|
|
137
158
|
}
|
|
138
159
|
}
|
|
139
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
160
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVsZWFzZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvcmVsZWFzZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUlMLFFBQVEsRUFDVCxNQUFNLHNCQUFzQixDQUFBO0FBQzdCLE9BQU8sRUFFTCxhQUFhLEVBQ2QsTUFBTSx3QkFBd0IsQ0FBQTtBQUMvQixPQUFPLEVBQUUsc0JBQXNCLEVBQUUsTUFBTSxjQUFjLENBQUE7QUFDckQsT0FBTyxFQUNMLGVBQWUsRUFDZixtQkFBbUIsRUFDcEIsTUFBTSxpQkFBaUIsQ0FBQTtBQVN4QixNQUFNLE9BQU8sb0JBQWtELFNBQVEsUUFBMEI7SUFHL0YsWUFDRSxPQUF1QztRQUV2QyxLQUFLLENBQUM7WUFDSixPQUFPLEVBQUUsSUFBSSxhQUFhLENBQUM7Z0JBQ3pCLE9BQU8sRUFBRSxPQUFPLENBQUMsT0FBNkI7YUFDL0MsQ0FBQztZQUNGLEdBQUcsT0FBTztTQUNYLENBQUMsQ0FBQTtJQUNKLENBQUM7SUFFUSxRQUFRLENBQUMsTUFBZTtRQUMvQixPQUFPLEtBQUssQ0FBQyxRQUFRLENBQUMsTUFBTSxFQUFFO1lBQzVCLFFBQVEsRUFBRSxxQkFBcUI7WUFDL0IsS0FBSyxFQUFFLDhDQUE4QztZQUNyRCxLQUFLLEVBQUUsSUFBSTtZQUNYLEtBQUssRUFBRSxJQUFJO1NBQ1osQ0FBQyxDQUFBO0lBQ0osQ0FBQztJQUVEOzs7T0FHRztJQUNILFlBQVk7UUFDVixPQUFPLElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxJQUFJLEVBQUU7WUFDN0IsTUFBTSxFQUFFLFVBQVUsRUFBRSxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUE7WUFFakMsSUFBSSxDQUFDLFVBQVUsRUFBRSxDQUFDO2dCQUNoQixNQUFNLElBQUksS0FBSyxDQUFDLHNFQUFzRSxDQUFDLENBQUE7WUFDekYsQ0FBQztZQUVELE1BQU0sRUFDSixPQUFPLEVBQ1AsT0FBTyxFQUNQLE1BQU0sRUFDUCxHQUFHLElBQUksQ0FBQTtZQUVSLE1BQU0sQ0FBQyxJQUFJLENBQUMsZUFBZSxFQUFFLGdEQUFnRCxDQUFDLENBQUE7WUFFOUUsTUFBTSxFQUFFLE9BQU8sRUFBRSxHQUFHLE9BQU8sQ0FBQTtZQUMzQixNQUFNLFlBQVksR0FBRyxNQUFNLE9BQU8sQ0FBQyxlQUFlLENBQUMsT0FBTyxDQUFDLENBQUE7WUFDM0QsTUFBTSxFQUFFLElBQUksRUFBRSxDQUFDLEVBQUUsQ0FBQyxFQUFFLEdBQUcsTUFBTSxPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUM7Z0JBQ25ELEdBQUcsWUFBWTtnQkFDZixJQUFJLEVBQUUsR0FBRyxZQUFZLENBQUMsS0FBSyxJQUFJLFVBQVUsRUFBRTtnQkFDM0MsS0FBSyxFQUFFLE1BQU07YUFDZCxDQUFDLENBQUE7WUFFRixJQUFJLENBQUMsRUFBRSxFQUFFLENBQUM7Z0JBQ1IsTUFBTSxDQUFDLElBQUksQ0FBQyxlQUFlLEVBQUUsNkJBQTZCLENBQUMsQ0FBQTtnQkFDM0QsT0FBTTtZQUNSLENBQUM7WUFFRCxNQUFNLEVBQUUsSUFBSSxFQUFFLFFBQVEsRUFBRSxHQUFHLE1BQU0sT0FBTyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsWUFBWSxDQUFDO2dCQUNoRSxHQUFHLFlBQVk7Z0JBQ2YsWUFBWSxFQUFFLEVBQUUsQ0FBQyxNQUFNO2FBQ3hCLENBQUMsQ0FBQTtZQUVGLEtBQUssSUFBSSxDQUFDLEdBQUcsUUFBUSxDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLEVBQUUsRUFBRSxDQUFDO2dCQUM5QyxNQUFNLElBQUksR0FBRyxzQkFBc0IsQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQTtnQkFFaEQsSUFBSSxJQUFJLEVBQUUsQ0FBQztvQkFDVCxJQUFJLENBQUM7d0JBQ0gsTUFBTSxPQUFPLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQTRCLENBQUE7d0JBRTNELE1BQU0sQ0FBQyxPQUFPLENBQUMsZUFBZSxFQUFFLDRCQUE0QixDQUFDLENBQUE7d0JBQzdELE1BQU0sQ0FBQyxPQUFPLENBQUMsZUFBZSxFQUFFLElBQUksQ0FBQyxDQUFBO3dCQUVyQyxLQUFLLENBQUMsVUFBVSxDQUFDLE9BQU8sQ0FBQyxDQUFBO29CQUMzQixDQUFDO29CQUFDLE1BQU0sQ0FBQzt3QkFDUCxNQUFNLENBQUMsT0FBTyxDQUFDLGVBQWUsRUFBRSxxQ0FBcUMsQ0FBQyxDQUFBO3dCQUN0RSxNQUFNLENBQUMsT0FBTyxDQUFDLGVBQWUsRUFBRSxJQUFJLENBQUMsQ0FBQTtvQkFDdkMsQ0FBQztvQkFFRCxNQUFLO2dCQUNQLENBQUM7WUFDSCxDQUFDO1FBQ0gsQ0FBQyxDQUFDLENBQUE7SUFDSixDQUFDO0lBRVEsR0FBRztRQUNWLE9BQU8sS0FBSyxDQUFDLEdBQUcsQ0FBQztZQUNmLEtBQUssRUFBRSxJQUFJO1NBQ1osQ0FBQyxDQUFBO0lBQ0osQ0FBQztJQUVRLElBQUk7UUFDWCxPQUFPLEtBQUssQ0FBQyxJQUFJLENBQUM7WUFDaEIsS0FBSyxFQUFFLElBQUk7U0FDWixDQUFDLENBQUE7SUFDSixDQUFDO0lBRUQ7O09BRUc7SUFDSCxLQUFLLENBQUMsb0JBQW9CO1FBQ3hCLE1BQU0sSUFBSTthQUNQLFFBQVEsRUFBRTthQUNWLFlBQVksRUFBRTthQUNkLElBQUksRUFBRTthQUNOLE1BQU0sRUFBRTthQUNSLElBQUksRUFBRTthQUNOLFdBQVcsRUFBRTthQUNiLEdBQUcsRUFBRSxDQUFBO0lBQ1YsQ0FBQztJQUVEOzs7T0FHRztJQUNILEtBQUssQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFLLEdBQUcsSUFBSTtRQUNqQyxNQUFNLElBQUk7YUFDUCxpQkFBaUIsRUFBRTthQUNuQixHQUFHLEVBQUU7YUFDTCxJQUFJLEVBQUU7YUFDTixPQUFPLEVBQUU7YUFDVCxPQUFPLEVBQUU7YUFDVCxHQUFHLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxlQUFlLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxDQUFBO0lBQzdDLENBQUM7SUFFRDs7O09BR0c7SUFDSCxLQUFLLENBQUMsaUJBQWlCLENBQUMsV0FBbUI7UUFDekMsSUFBSSxDQUFDLFdBQVcsRUFBRSxDQUFDO1lBQ2pCLE1BQU0sSUFBSSxLQUFLLENBQUMsMkJBQTJCLENBQUMsQ0FBQTtRQUM5QyxDQUFDO1FBRUQsTUFBTSxJQUFJO2FBQ1AsSUFBSSxDQUFDO1lBQ0osUUFBUSxFQUFFLFdBQVc7WUFDckIsYUFBYSxFQUFFLElBQUk7U0FDaUIsQ0FBQzthQUN0QyxPQUFPLENBQUM7WUFDUCxHQUFHLEVBQUUsV0FBVztZQUNoQixTQUFTLEVBQUUsS0FBSztTQUN1QixDQUFDO2FBQ3pDLE1BQU0sRUFBRTthQUNSLEdBQUcsRUFBRSxDQUFBO0lBQ1YsQ0FBQztJQUVEOztPQUVHO0lBQ0gsS0FBSyxDQUFDLFNBQVM7UUFDYixNQUFNLEVBQ0osTUFBTSxFQUNOLFNBQVMsRUFDVixHQUFHLElBQUksQ0FBQTtRQUVSLE1BQU0sQ0FBQyxJQUFJLENBQUMsS0FBSyxFQUFFLHFCQUFxQixDQUFDLENBQUE7UUFFekMsTUFBTSxtQkFBbUIsR0FBRyxtQkFBbUIsRUFBRSxDQUFBO1FBQ2pELElBQUksZUFBZSxHQUFHLEtBQUssQ0FBQTtRQUUzQixJQUFJLG1CQUFtQixLQUFLLEtBQUssRUFBRSxDQUFDO1lBQ2xDLE1BQU0sQ0FBQyxJQUFJLENBQUMsS0FBSyxFQUFFLDZDQUE2QyxDQUFDLENBQUE7WUFDakUsTUFBTSxDQUFDLElBQUksQ0FBQyxLQUFLLEVBQUUsNkRBQTZELENBQUMsQ0FBQTtZQUNqRixNQUFNLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQTtZQUNoQixPQUFNO1FBQ1IsQ0FBQztRQUVELElBQUksbUJBQW1CLEtBQUssSUFBSSxFQUFFLENBQUM7WUFDakMsTUFBTSxDQUFDLElBQUksQ0FBQyxLQUFLLEVBQUUsNkNBQTZDLENBQUMsQ0FBQTtZQUVqRSxNQUFNLGFBQWEsR0FBRyxNQUFNLFNBQVMsQ0FBQyxnQkFBZ0IsRUFBRSxDQUFBO1lBRXhELElBQUksYUFBYSxLQUFLLG1CQUFtQixFQUFFLENBQUM7Z0JBQzFDLEtBQUssQ0FBQyxRQUFRLENBQUMsbUJBQW1CLEVBQUU7b0JBQ2xDLEtBQUssRUFBRSxJQUFJO29CQUNYLEtBQUssRUFBRSxLQUFLO2lCQUNiLENBQUMsQ0FBQTtZQUNKLENBQUM7UUFDSCxDQUFDO2FBQU0sQ0FBQztZQUNOLGVBQWUsR0FBRyxNQUFNLGVBQWUsQ0FBQyxJQUFJLENBQUMsQ0FBQTtRQUMvQyxDQUFDO1FBRUQsSUFBSSxlQUFlLEVBQUUsQ0FBQztZQUNwQixNQUFNLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSwyQkFBMkIsQ0FBQyxDQUFBO1lBQy9DLE1BQU0sSUFBSSxDQUFDLGdCQUFnQixDQUFDLEtBQUssQ0FBQyxDQUFBO1FBQ3BDLENBQUM7YUFBTSxDQUFDO1lBQ04sTUFBTSxDQUFDLElBQUksQ0FBQyxLQUFLLEVBQUUsZ0NBQWdDLENBQUMsQ0FBQTtZQUNwRCxNQUFNLElBQUksQ0FBQyxvQkFBb0IsRUFBRSxDQUFBO1FBQ25DLENBQUM7SUFDSCxDQUFDO0NBQ0YifQ==
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@simple-release/github-action",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "3.0.1",
|
|
5
5
|
"description": "A simple-release api for github action.",
|
|
6
6
|
"author": {
|
|
7
7
|
"name": "Dan Onoshko",
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
"changelog"
|
|
28
28
|
],
|
|
29
29
|
"engines": {
|
|
30
|
-
"node": ">=
|
|
30
|
+
"node": ">=22"
|
|
31
31
|
},
|
|
32
32
|
"exports": {
|
|
33
33
|
"types": "./dist/index.d.ts",
|
|
@@ -37,9 +37,10 @@
|
|
|
37
37
|
"dist"
|
|
38
38
|
],
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@actions/
|
|
41
|
-
"@
|
|
42
|
-
"@simple-release/
|
|
43
|
-
"@simple-release/github": "^
|
|
40
|
+
"@actions/core": "^3.0.1",
|
|
41
|
+
"@actions/github": "^9.0.0",
|
|
42
|
+
"@simple-release/config": "^3.0.0",
|
|
43
|
+
"@simple-release/github": "^3.0.0",
|
|
44
|
+
"@simple-release/core": "^3.0.0"
|
|
44
45
|
}
|
|
45
46
|
}
|