@simple-release/github-action 2.0.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 +21 -0
- package/README.md +118 -0
- package/dist/comment.d.ts +8 -0
- package/dist/comment.d.ts.map +1 -0
- package/dist/comment.js +22 -0
- package/dist/conditions.d.ts +4 -0
- package/dist/conditions.d.ts.map +1 -0
- package/dist/conditions.js +31 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +3 -0
- package/dist/releaser.d.ts +34 -0
- package/dist/releaser.d.ts.map +1 -0
- package/dist/releaser.js +135 -0
- package/package.json +45 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2016 - present, TrigenSoftware
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
# @simple-release/github-action
|
|
2
|
+
|
|
3
|
+
[![ESM-only package][package]][package-url]
|
|
4
|
+
[![NPM version][npm]][npm-url]
|
|
5
|
+
[![Node version][node]][node-url]
|
|
6
|
+
[![Dependencies status][deps]][deps-url]
|
|
7
|
+
[![Install size][size]][size-url]
|
|
8
|
+
[![Build status][build]][build-url]
|
|
9
|
+
[![Coverage status][coverage]][coverage-url]
|
|
10
|
+
|
|
11
|
+
[package]: https://img.shields.io/badge/package-ESM--only-ffe536.svg
|
|
12
|
+
[package-url]: https://nodejs.org/api/esm.html
|
|
13
|
+
|
|
14
|
+
[npm]: https://img.shields.io/npm/v/@simple-release/github-action.svg
|
|
15
|
+
[npm-url]: https://www.npmjs.com/package/@simple-release/github-action
|
|
16
|
+
|
|
17
|
+
[node]: https://img.shields.io/node/v/@simple-release/github-action.svg
|
|
18
|
+
[node-url]: https://nodejs.org
|
|
19
|
+
|
|
20
|
+
[deps]: https://img.shields.io/librariesio/release/npm/@simple-release/github-action
|
|
21
|
+
[deps-url]: https://libraries.io/npm/@simple-release%2Fgithub-actions/tree
|
|
22
|
+
|
|
23
|
+
[size]: https://packagephobia.com/badge?p=@simple-release/github-action
|
|
24
|
+
[size-url]: https://packagephobia.com/result?p=@simple-release/github-action
|
|
25
|
+
|
|
26
|
+
[build]: https://img.shields.io/github/actions/workflow/status/TrigenSoftware/simple-release/tests.yml?branch=main
|
|
27
|
+
[build-url]: https://github.com/TrigenSoftware/simple-release/actions
|
|
28
|
+
|
|
29
|
+
[coverage]: https://coveralls.io/repos/github/TrigenSoftware/simple-release/badge.svg?branch=main
|
|
30
|
+
[coverage-url]: https://coveralls.io/github/TrigenSoftware/simple-release?branch=main
|
|
31
|
+
|
|
32
|
+
A simple-release api for github action.
|
|
33
|
+
|
|
34
|
+
## Install
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
# pnpm
|
|
38
|
+
pnpm add @simple-release/github-action
|
|
39
|
+
# yarn
|
|
40
|
+
yarn add @simple-release/github-action
|
|
41
|
+
# npm
|
|
42
|
+
npm i @simple-release/github-action
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Usage
|
|
46
|
+
|
|
47
|
+
```js
|
|
48
|
+
import { getOctokit } from '@actions/github'
|
|
49
|
+
import { load } from '@simple-release/config'
|
|
50
|
+
import { ReleaserGithubAction, ifReleaseCommit } from '@simple-release/github-action'
|
|
51
|
+
|
|
52
|
+
const {
|
|
53
|
+
project,
|
|
54
|
+
releaser,
|
|
55
|
+
...options
|
|
56
|
+
} = await load({
|
|
57
|
+
config: true,
|
|
58
|
+
project: true
|
|
59
|
+
})
|
|
60
|
+
const action = await new ReleaserGithubAction({
|
|
61
|
+
project,
|
|
62
|
+
octokit: getOctokit(token),
|
|
63
|
+
...releaser
|
|
64
|
+
})
|
|
65
|
+
|
|
66
|
+
// Create pull request with version bump
|
|
67
|
+
action
|
|
68
|
+
.setOptions(options)
|
|
69
|
+
.checkout()
|
|
70
|
+
.fetchOptions()
|
|
71
|
+
.bump()
|
|
72
|
+
.commit()
|
|
73
|
+
.push()
|
|
74
|
+
.pullRequest()
|
|
75
|
+
.run()
|
|
76
|
+
|
|
77
|
+
// Publish release and project
|
|
78
|
+
action
|
|
79
|
+
.setOptions(options)
|
|
80
|
+
.tag()
|
|
81
|
+
.push()
|
|
82
|
+
.release()
|
|
83
|
+
.publish()
|
|
84
|
+
.run(ifReleaseCommit)
|
|
85
|
+
|
|
86
|
+
// Run all steps to create a pull request with version bump
|
|
87
|
+
action
|
|
88
|
+
.setOptions(options)
|
|
89
|
+
.runPullRequestAction()
|
|
90
|
+
|
|
91
|
+
// Run all steps to release project
|
|
92
|
+
action
|
|
93
|
+
.setOptions(options)
|
|
94
|
+
.runReleaseAction()
|
|
95
|
+
|
|
96
|
+
// Detect action by commit type and run appropriate steps
|
|
97
|
+
action
|
|
98
|
+
.setOptions(options)
|
|
99
|
+
.runAction()
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### fethchOptions
|
|
103
|
+
|
|
104
|
+
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
|
+
|
|
106
|
+
````
|
|
107
|
+
!simple-release/set-options
|
|
108
|
+
|
|
109
|
+
```json
|
|
110
|
+
{
|
|
111
|
+
"bump": {
|
|
112
|
+
"prerelease": "alpha"
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
```
|
|
116
|
+
````
|
|
117
|
+
|
|
118
|
+
To fetch and parse comments you should use `fetchOptions` step after `checkout` step.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
interface Comment {
|
|
2
|
+
body?: string;
|
|
3
|
+
author_association: string;
|
|
4
|
+
}
|
|
5
|
+
export declare const SET_OPTION_COMMAND = "!simple-release/set-options";
|
|
6
|
+
export declare function parseSetOptionsComment(comment: Comment): string | null;
|
|
7
|
+
export {};
|
|
8
|
+
//# sourceMappingURL=comment.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"comment.d.ts","sourceRoot":"","sources":["../src/comment.ts"],"names":[],"mappings":"AAAA,UAAU,OAAO;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAWD,eAAO,MAAM,kBAAkB,gCAAgC,CAAA;AAE/D,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CActE"}
|
package/dist/comment.js
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
const ALLOWED_AUTHOR_ASSOCIATIONS = [
|
|
2
|
+
'OWNER',
|
|
3
|
+
'COLLABORATOR',
|
|
4
|
+
'MEMBER'
|
|
5
|
+
];
|
|
6
|
+
const JSON_START = '```json';
|
|
7
|
+
const JSON_START_OFFSET = JSON_START.length;
|
|
8
|
+
const JSON_END = '```';
|
|
9
|
+
export const SET_OPTION_COMMAND = '!simple-release/set-options';
|
|
10
|
+
export function parseSetOptionsComment(comment) {
|
|
11
|
+
if (ALLOWED_AUTHOR_ASSOCIATIONS.includes(comment.author_association)) {
|
|
12
|
+
const { body } = comment;
|
|
13
|
+
if (body?.startsWith(SET_OPTION_COMMAND)) {
|
|
14
|
+
const start = body.indexOf(JSON_START);
|
|
15
|
+
const end = body.lastIndexOf(JSON_END);
|
|
16
|
+
const json = body.substring(start + JSON_START_OFFSET, end).trim();
|
|
17
|
+
return json;
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
return null;
|
|
21
|
+
}
|
|
22
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWVudC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9jb21tZW50LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUtBLE1BQU0sMkJBQTJCLEdBQUc7SUFDbEMsT0FBTztJQUNQLGNBQWM7SUFDZCxRQUFRO0NBQ1QsQ0FBQTtBQUNELE1BQU0sVUFBVSxHQUFHLFNBQVMsQ0FBQTtBQUM1QixNQUFNLGlCQUFpQixHQUFHLFVBQVUsQ0FBQyxNQUFNLENBQUE7QUFDM0MsTUFBTSxRQUFRLEdBQUcsS0FBSyxDQUFBO0FBRXRCLE1BQU0sQ0FBQyxNQUFNLGtCQUFrQixHQUFHLDZCQUE2QixDQUFBO0FBRS9ELE1BQU0sVUFBVSxzQkFBc0IsQ0FBQyxPQUFnQjtJQUNyRCxJQUFJLDJCQUEyQixDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUMsa0JBQWtCLENBQUMsRUFBRTtRQUNwRSxNQUFNLEVBQUUsSUFBSSxFQUFFLEdBQUcsT0FBTyxDQUFBO1FBRXhCLElBQUksSUFBSSxFQUFFLFVBQVUsQ0FBQyxrQkFBa0IsQ0FBQyxFQUFFO1lBQ3hDLE1BQU0sS0FBSyxHQUFHLElBQUksQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDLENBQUE7WUFDdEMsTUFBTSxHQUFHLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBQyxRQUFRLENBQUMsQ0FBQTtZQUN0QyxNQUFNLElBQUksR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDLEtBQUssR0FBRyxpQkFBaUIsRUFBRSxHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQTtZQUVsRSxPQUFPLElBQUksQ0FBQTtTQUNaO0tBQ0Y7SUFFRCxPQUFPLElBQUksQ0FBQTtBQUNiLENBQUMifQ==
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"conditions.d.ts","sourceRoot":"","sources":["../src/conditions.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAGzD,wBAAsB,eAAe,CAAC,QAAQ,EAAE,oBAAoB,oBASnE;AAED,wBAAgB,mBAAmB,0BAgClC"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { context } from '@actions/github';
|
|
2
|
+
import { SET_OPTION_COMMAND } from './comment.js';
|
|
3
|
+
export async function ifReleaseCommit(releaser) {
|
|
4
|
+
const { gitClient, project } = releaser;
|
|
5
|
+
const message = await gitClient.exec('log', '-1', '--pretty=%B');
|
|
6
|
+
const tags = await project.getTags();
|
|
7
|
+
return tags.length > 0 && message.startsWith('chore(release):');
|
|
8
|
+
}
|
|
9
|
+
export function ifSetOptionsComment() {
|
|
10
|
+
const { eventName, payload: { issue, comment } } = context;
|
|
11
|
+
const isPullRequest = issue?.pull_request;
|
|
12
|
+
const issueAuthor = issue?.user?.login;
|
|
13
|
+
const issueBody = issue?.body;
|
|
14
|
+
const issueState = issue?.state;
|
|
15
|
+
const commentBody = comment?.body;
|
|
16
|
+
if (eventName === 'issue_comment') {
|
|
17
|
+
if (isPullRequest
|
|
18
|
+
&& issueAuthor === 'github-actions[bot]'
|
|
19
|
+
&& issueState === 'open'
|
|
20
|
+
&& issueBody?.includes('simple-release-pull-request: true')
|
|
21
|
+
&& commentBody?.includes(SET_OPTION_COMMAND)) {
|
|
22
|
+
const matches = issueBody.match(/simple-release-branch-to:\s*([^\s]+)/);
|
|
23
|
+
if (matches) {
|
|
24
|
+
return matches[1];
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
return false; // not a pull request comment, stop action
|
|
28
|
+
}
|
|
29
|
+
return null; // continue
|
|
30
|
+
}
|
|
31
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZGl0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9jb25kaXRpb25zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQTtBQUV6QyxPQUFPLEVBQUUsa0JBQWtCLEVBQUUsTUFBTSxjQUFjLENBQUE7QUFFakQsTUFBTSxDQUFDLEtBQUssVUFBVSxlQUFlLENBQUMsUUFBOEI7SUFDbEUsTUFBTSxFQUNKLFNBQVMsRUFDVCxPQUFPLEVBQ1IsR0FBRyxRQUFRLENBQUE7SUFDWixNQUFNLE9BQU8sR0FBRyxNQUFNLFNBQVMsQ0FBQyxJQUFJLENBQUMsS0FBSyxFQUFFLElBQUksRUFBRSxhQUFhLENBQUMsQ0FBQTtJQUNoRSxNQUFNLElBQUksR0FBRyxNQUFNLE9BQU8sQ0FBQyxPQUFPLEVBQUUsQ0FBQTtJQUVwQyxPQUFPLElBQUksQ0FBQyxNQUFNLEdBQUcsQ0FBQyxJQUFJLE9BQU8sQ0FBQyxVQUFVLENBQUMsaUJBQWlCLENBQUMsQ0FBQTtBQUNqRSxDQUFDO0FBRUQsTUFBTSxVQUFVLG1CQUFtQjtJQUNqQyxNQUFNLEVBQ0osU0FBUyxFQUNULE9BQU8sRUFBRSxFQUNQLEtBQUssRUFDTCxPQUFPLEVBQ1IsRUFDRixHQUFHLE9BQU8sQ0FBQTtJQUNYLE1BQU0sYUFBYSxHQUFHLEtBQUssRUFBRSxZQUF1QixDQUFBO0lBQ3BELE1BQU0sV0FBVyxHQUFJLEtBQUssRUFBRSxJQUFzQyxFQUFFLEtBQUssQ0FBQTtJQUN6RSxNQUFNLFNBQVMsR0FBRyxLQUFLLEVBQUUsSUFBSSxDQUFBO0lBQzdCLE1BQU0sVUFBVSxHQUFHLEtBQUssRUFBRSxLQUFlLENBQUE7SUFDekMsTUFBTSxXQUFXLEdBQUksT0FBeUMsRUFBRSxJQUFJLENBQUE7SUFFcEUsSUFBSSxTQUFTLEtBQUssZUFBZSxFQUFFO1FBQ2pDLElBQUksYUFBYTtlQUNaLFdBQVcsS0FBSyxxQkFBcUI7ZUFDckMsVUFBVSxLQUFLLE1BQU07ZUFDckIsU0FBUyxFQUFFLFFBQVEsQ0FBQyxtQ0FBbUMsQ0FBQztlQUN4RCxXQUFXLEVBQUUsUUFBUSxDQUFDLGtCQUFrQixDQUFDLEVBQzVDO1lBQ0EsTUFBTSxPQUFPLEdBQUcsU0FBUyxDQUFDLEtBQUssQ0FBQyxzQ0FBc0MsQ0FBQyxDQUFBO1lBRXZFLElBQUksT0FBTyxFQUFFO2dCQUNYLE9BQU8sT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFBO2FBQ2xCO1NBQ0Y7UUFFRCxPQUFPLEtBQUssQ0FBQSxDQUFDLDBDQUEwQztLQUN4RDtJQUVELE9BQU8sSUFBSSxDQUFBLENBQUMsV0FBVztBQUN6QixDQUFDIn0=
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export * from './releaser.js';
|
|
2
|
+
export * from './conditions.js';
|
|
3
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxlQUFlLENBQUE7QUFDN0IsY0FBYyxpQkFBaUIsQ0FBQSJ9
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { getOctokit } from '@actions/github';
|
|
2
|
+
import { type Project, type ReleaserOptions, Releaser } from '@simple-release/core';
|
|
3
|
+
import { GithubHosting } from '@simple-release/github';
|
|
4
|
+
export interface ReleaserGithubActionOptions<P extends Project = Project> extends Omit<ReleaserOptions<P, GithubHosting>, 'hosting'> {
|
|
5
|
+
/**
|
|
6
|
+
* The Octokit instance to use for making GitHub API calls.
|
|
7
|
+
*/
|
|
8
|
+
octokit: ReturnType<typeof getOctokit>;
|
|
9
|
+
}
|
|
10
|
+
export declare class ReleaserGithubAction<P extends Project = Project> extends Releaser<P, GithubHosting> {
|
|
11
|
+
hosting: GithubHosting;
|
|
12
|
+
constructor(options: ReleaserGithubActionOptions<P>);
|
|
13
|
+
checkout(branch?: string): this;
|
|
14
|
+
/**
|
|
15
|
+
* Fetches options from the pull request comments.
|
|
16
|
+
* @returns Project releaser instance for chaining.
|
|
17
|
+
*/
|
|
18
|
+
fetchOptions(): this;
|
|
19
|
+
push(): this;
|
|
20
|
+
/**
|
|
21
|
+
* Run all steps to create a pull request.
|
|
22
|
+
*/
|
|
23
|
+
runPullRequestAction(): Promise<void>;
|
|
24
|
+
/**
|
|
25
|
+
* Run all steps to release a new version.
|
|
26
|
+
* @param check - Whether to check if the commit is a release commit.
|
|
27
|
+
*/
|
|
28
|
+
runReleaseAction(check?: boolean): Promise<void>;
|
|
29
|
+
/**
|
|
30
|
+
* Run action based on the context.
|
|
31
|
+
*/
|
|
32
|
+
runAction(): Promise<void>;
|
|
33
|
+
}
|
|
34
|
+
//# sourceMappingURL=releaser.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"releaser.d.ts","sourceRoot":"","sources":["../src/releaser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EACL,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;gBAG5B,OAAO,EAAE,2BAA2B,CAAC,CAAC,CAAC;IAUhC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM;IASjC;;;OAGG;IACH,YAAY;IAwDH,IAAI;IAMb;;OAEG;IACG,oBAAoB;IAW1B;;;OAGG;IACG,gBAAgB,CAAC,KAAK,UAAO;IASnC;;OAEG;IACG,SAAS;CAyChB"}
|
package/dist/releaser.js
ADDED
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
import { getOctokit } from '@actions/github';
|
|
2
|
+
import { Releaser } from '@simple-release/core';
|
|
3
|
+
import { GithubHosting } from '@simple-release/github';
|
|
4
|
+
import { parseSetOptionsComment } from './comment.js';
|
|
5
|
+
import { ifReleaseCommit, ifSetOptionsComment } from './conditions.js';
|
|
6
|
+
export class ReleaserGithubAction extends Releaser {
|
|
7
|
+
constructor(options) {
|
|
8
|
+
super({
|
|
9
|
+
hosting: new GithubHosting({
|
|
10
|
+
octokit: options.octokit
|
|
11
|
+
}),
|
|
12
|
+
...options
|
|
13
|
+
});
|
|
14
|
+
}
|
|
15
|
+
checkout(branch) {
|
|
16
|
+
return super.checkout(branch, {
|
|
17
|
+
username: 'github-actions[bot]',
|
|
18
|
+
email: 'github-actions[bot]@users.noreply.github.com',
|
|
19
|
+
fetch: true,
|
|
20
|
+
force: true
|
|
21
|
+
});
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Fetches options from the pull request comments.
|
|
25
|
+
* @returns Project releaser instance for chaining.
|
|
26
|
+
*/
|
|
27
|
+
fetchOptions() {
|
|
28
|
+
return this.enqueue(async () => {
|
|
29
|
+
const { headBranch } = this.state;
|
|
30
|
+
if (!headBranch) {
|
|
31
|
+
throw new Error('Head branch is not set. Please call `checkout` before `fetchParams`.');
|
|
32
|
+
}
|
|
33
|
+
const { project, hosting, logger } = this;
|
|
34
|
+
logger.info('fetch-options', 'Fetching options from pull request comments...');
|
|
35
|
+
const { octokit } = hosting;
|
|
36
|
+
const repositoryId = await hosting.getRepositoryId(project);
|
|
37
|
+
const { data: [pr] } = await octokit.rest.pulls.list({
|
|
38
|
+
...repositoryId,
|
|
39
|
+
head: `${repositoryId.owner}:${headBranch}`,
|
|
40
|
+
state: 'open'
|
|
41
|
+
});
|
|
42
|
+
if (!pr) {
|
|
43
|
+
logger.info('fetch-options', 'No open pull request found.');
|
|
44
|
+
return;
|
|
45
|
+
}
|
|
46
|
+
const { data: comments } = await octokit.rest.issues.listComments({
|
|
47
|
+
...repositoryId,
|
|
48
|
+
issue_number: pr.number
|
|
49
|
+
});
|
|
50
|
+
for (let i = comments.length - 1; i >= 0; i--) {
|
|
51
|
+
const json = parseSetOptionsComment(comments[i]);
|
|
52
|
+
if (json) {
|
|
53
|
+
try {
|
|
54
|
+
const options = JSON.parse(json);
|
|
55
|
+
logger.verbose('fetch-options', 'Found set-options comment:');
|
|
56
|
+
logger.verbose('fetch-options', json);
|
|
57
|
+
super.setOptions(options);
|
|
58
|
+
}
|
|
59
|
+
catch (error) {
|
|
60
|
+
logger.verbose('fetch-options', 'Failed to parse parameters comment:');
|
|
61
|
+
logger.verbose('fetch-options', json);
|
|
62
|
+
}
|
|
63
|
+
break;
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
push() {
|
|
69
|
+
return super.push({
|
|
70
|
+
force: true
|
|
71
|
+
});
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Run all steps to create a pull request.
|
|
75
|
+
*/
|
|
76
|
+
async runPullRequestAction() {
|
|
77
|
+
await this
|
|
78
|
+
.checkout()
|
|
79
|
+
.fetchOptions()
|
|
80
|
+
.bump()
|
|
81
|
+
.commit()
|
|
82
|
+
.push()
|
|
83
|
+
.pullRequest()
|
|
84
|
+
.run();
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Run all steps to release a new version.
|
|
88
|
+
* @param check - Whether to check if the commit is a release commit.
|
|
89
|
+
*/
|
|
90
|
+
async runReleaseAction(check = true) {
|
|
91
|
+
await this
|
|
92
|
+
.tag()
|
|
93
|
+
.push()
|
|
94
|
+
.release()
|
|
95
|
+
.publish()
|
|
96
|
+
.run(check ? ifReleaseCommit : undefined);
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Run action based on the context.
|
|
100
|
+
*/
|
|
101
|
+
async runAction() {
|
|
102
|
+
const { logger, gitClient } = this;
|
|
103
|
+
logger.info('run', 'Detecting action...');
|
|
104
|
+
const isSetOptionsComment = ifSetOptionsComment();
|
|
105
|
+
let isReleaseCommit = false;
|
|
106
|
+
if (isSetOptionsComment === false) {
|
|
107
|
+
logger.info('run', 'Action triggered by a pull request comment.');
|
|
108
|
+
logger.info('run', 'No set-options comment found in a comment. Stopping action.');
|
|
109
|
+
await this.run();
|
|
110
|
+
return;
|
|
111
|
+
}
|
|
112
|
+
if (isSetOptionsComment !== null) {
|
|
113
|
+
logger.info('run', 'Action triggered by a pull request comment.');
|
|
114
|
+
const currentBranch = await gitClient.getCurrentBranch();
|
|
115
|
+
if (currentBranch !== isSetOptionsComment) {
|
|
116
|
+
super.checkout(isSetOptionsComment, {
|
|
117
|
+
fetch: true,
|
|
118
|
+
force: false
|
|
119
|
+
});
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
else {
|
|
123
|
+
isReleaseCommit = await ifReleaseCommit(this);
|
|
124
|
+
}
|
|
125
|
+
if (isReleaseCommit) {
|
|
126
|
+
logger.info('run', 'Running release action...');
|
|
127
|
+
await this.runReleaseAction(false);
|
|
128
|
+
}
|
|
129
|
+
else {
|
|
130
|
+
logger.info('run', 'Running pull request action...');
|
|
131
|
+
await this.runPullRequestAction();
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVsZWFzZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvcmVsZWFzZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFVBQVUsRUFBRSxNQUFNLGlCQUFpQixDQUFBO0FBQzVDLE9BQU8sRUFHTCxRQUFRLEVBQ1QsTUFBTSxzQkFBc0IsQ0FBQTtBQUM3QixPQUFPLEVBRUwsYUFBYSxFQUNkLE1BQU0sd0JBQXdCLENBQUE7QUFDL0IsT0FBTyxFQUFFLHNCQUFzQixFQUFFLE1BQU0sY0FBYyxDQUFBO0FBQ3JELE9BQU8sRUFDTCxlQUFlLEVBQ2YsbUJBQW1CLEVBQ3BCLE1BQU0saUJBQWlCLENBQUE7QUFTeEIsTUFBTSxPQUFPLG9CQUFrRCxTQUFRLFFBQTBCO0lBRy9GLFlBQ0UsT0FBdUM7UUFFdkMsS0FBSyxDQUFDO1lBQ0osT0FBTyxFQUFFLElBQUksYUFBYSxDQUFDO2dCQUN6QixPQUFPLEVBQUUsT0FBTyxDQUFDLE9BQTZCO2FBQy9DLENBQUM7WUFDRixHQUFHLE9BQU87U0FDWCxDQUFDLENBQUE7SUFDSixDQUFDO0lBRVEsUUFBUSxDQUFDLE1BQWU7UUFDL0IsT0FBTyxLQUFLLENBQUMsUUFBUSxDQUFDLE1BQU0sRUFBRTtZQUM1QixRQUFRLEVBQUUscUJBQXFCO1lBQy9CLEtBQUssRUFBRSw4Q0FBOEM7WUFDckQsS0FBSyxFQUFFLElBQUk7WUFDWCxLQUFLLEVBQUUsSUFBSTtTQUNaLENBQUMsQ0FBQTtJQUNKLENBQUM7SUFFRDs7O09BR0c7SUFDSCxZQUFZO1FBQ1YsT0FBTyxJQUFJLENBQUMsT0FBTyxDQUFDLEtBQUssSUFBSSxFQUFFO1lBQzdCLE1BQU0sRUFBRSxVQUFVLEVBQUUsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFBO1lBRWpDLElBQUksQ0FBQyxVQUFVLEVBQUU7Z0JBQ2YsTUFBTSxJQUFJLEtBQUssQ0FBQyxzRUFBc0UsQ0FBQyxDQUFBO2FBQ3hGO1lBRUQsTUFBTSxFQUNKLE9BQU8sRUFDUCxPQUFPLEVBQ1AsTUFBTSxFQUNQLEdBQUcsSUFBSSxDQUFBO1lBRVIsTUFBTSxDQUFDLElBQUksQ0FBQyxlQUFlLEVBQUUsZ0RBQWdELENBQUMsQ0FBQTtZQUU5RSxNQUFNLEVBQUUsT0FBTyxFQUFFLEdBQUcsT0FBTyxDQUFBO1lBQzNCLE1BQU0sWUFBWSxHQUFHLE1BQU0sT0FBTyxDQUFDLGVBQWUsQ0FBQyxPQUFPLENBQUMsQ0FBQTtZQUMzRCxNQUFNLEVBQUUsSUFBSSxFQUFFLENBQUMsRUFBRSxDQUFDLEVBQUUsR0FBRyxNQUFNLE9BQU8sQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQztnQkFDbkQsR0FBRyxZQUFZO2dCQUNmLElBQUksRUFBRSxHQUFHLFlBQVksQ0FBQyxLQUFLLElBQUksVUFBVSxFQUFFO2dCQUMzQyxLQUFLLEVBQUUsTUFBTTthQUNkLENBQUMsQ0FBQTtZQUVGLElBQUksQ0FBQyxFQUFFLEVBQUU7Z0JBQ1AsTUFBTSxDQUFDLElBQUksQ0FBQyxlQUFlLEVBQUUsNkJBQTZCLENBQUMsQ0FBQTtnQkFDM0QsT0FBTTthQUNQO1lBRUQsTUFBTSxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsR0FBRyxNQUFNLE9BQU8sQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLFlBQVksQ0FBQztnQkFDaEUsR0FBRyxZQUFZO2dCQUNmLFlBQVksRUFBRSxFQUFFLENBQUMsTUFBTTthQUN4QixDQUFDLENBQUE7WUFFRixLQUFLLElBQUksQ0FBQyxHQUFHLFFBQVEsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxFQUFFLEVBQUU7Z0JBQzdDLE1BQU0sSUFBSSxHQUFHLHNCQUFzQixDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFBO2dCQUVoRCxJQUFJLElBQUksRUFBRTtvQkFDUixJQUFJO3dCQUNGLE1BQU0sT0FBTyxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUE0QixDQUFBO3dCQUUzRCxNQUFNLENBQUMsT0FBTyxDQUFDLGVBQWUsRUFBRSw0QkFBNEIsQ0FBQyxDQUFBO3dCQUM3RCxNQUFNLENBQUMsT0FBTyxDQUFDLGVBQWUsRUFBRSxJQUFJLENBQUMsQ0FBQTt3QkFFckMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsQ0FBQTtxQkFDMUI7b0JBQUMsT0FBTyxLQUFLLEVBQUU7d0JBQ2QsTUFBTSxDQUFDLE9BQU8sQ0FBQyxlQUFlLEVBQUUscUNBQXFDLENBQUMsQ0FBQTt3QkFDdEUsTUFBTSxDQUFDLE9BQU8sQ0FBQyxlQUFlLEVBQUUsSUFBSSxDQUFDLENBQUE7cUJBQ3RDO29CQUVELE1BQUs7aUJBQ047YUFDRjtRQUNILENBQUMsQ0FBQyxDQUFBO0lBQ0osQ0FBQztJQUVRLElBQUk7UUFDWCxPQUFPLEtBQUssQ0FBQyxJQUFJLENBQUM7WUFDaEIsS0FBSyxFQUFFLElBQUk7U0FDWixDQUFDLENBQUE7SUFDSixDQUFDO0lBRUQ7O09BRUc7SUFDSCxLQUFLLENBQUMsb0JBQW9CO1FBQ3hCLE1BQU0sSUFBSTthQUNQLFFBQVEsRUFBRTthQUNWLFlBQVksRUFBRTthQUNkLElBQUksRUFBRTthQUNOLE1BQU0sRUFBRTthQUNSLElBQUksRUFBRTthQUNOLFdBQVcsRUFBRTthQUNiLEdBQUcsRUFBRSxDQUFBO0lBQ1YsQ0FBQztJQUVEOzs7T0FHRztJQUNILEtBQUssQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFLLEdBQUcsSUFBSTtRQUNqQyxNQUFNLElBQUk7YUFDUCxHQUFHLEVBQUU7YUFDTCxJQUFJLEVBQUU7YUFDTixPQUFPLEVBQUU7YUFDVCxPQUFPLEVBQUU7YUFDVCxHQUFHLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxlQUFlLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxDQUFBO0lBQzdDLENBQUM7SUFFRDs7T0FFRztJQUNILEtBQUssQ0FBQyxTQUFTO1FBQ2IsTUFBTSxFQUNKLE1BQU0sRUFDTixTQUFTLEVBQ1YsR0FBRyxJQUFJLENBQUE7UUFFUixNQUFNLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxxQkFBcUIsQ0FBQyxDQUFBO1FBRXpDLE1BQU0sbUJBQW1CLEdBQUcsbUJBQW1CLEVBQUUsQ0FBQTtRQUNqRCxJQUFJLGVBQWUsR0FBRyxLQUFLLENBQUE7UUFFM0IsSUFBSSxtQkFBbUIsS0FBSyxLQUFLLEVBQUU7WUFDakMsTUFBTSxDQUFDLElBQUksQ0FBQyxLQUFLLEVBQUUsNkNBQTZDLENBQUMsQ0FBQTtZQUNqRSxNQUFNLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSw2REFBNkQsQ0FBQyxDQUFBO1lBQ2pGLE1BQU0sSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFBO1lBQ2hCLE9BQU07U0FDUDtRQUVELElBQUksbUJBQW1CLEtBQUssSUFBSSxFQUFFO1lBQ2hDLE1BQU0sQ0FBQyxJQUFJLENBQUMsS0FBSyxFQUFFLDZDQUE2QyxDQUFDLENBQUE7WUFFakUsTUFBTSxhQUFhLEdBQUcsTUFBTSxTQUFTLENBQUMsZ0JBQWdCLEVBQUUsQ0FBQTtZQUV4RCxJQUFJLGFBQWEsS0FBSyxtQkFBbUIsRUFBRTtnQkFDekMsS0FBSyxDQUFDLFFBQVEsQ0FBQyxtQkFBbUIsRUFBRTtvQkFDbEMsS0FBSyxFQUFFLElBQUk7b0JBQ1gsS0FBSyxFQUFFLEtBQUs7aUJBQ2IsQ0FBQyxDQUFBO2FBQ0g7U0FDRjthQUFNO1lBQ0wsZUFBZSxHQUFHLE1BQU0sZUFBZSxDQUFDLElBQUksQ0FBQyxDQUFBO1NBQzlDO1FBRUQsSUFBSSxlQUFlLEVBQUU7WUFDbkIsTUFBTSxDQUFDLElBQUksQ0FBQyxLQUFLLEVBQUUsMkJBQTJCLENBQUMsQ0FBQTtZQUMvQyxNQUFNLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFLLENBQUMsQ0FBQTtTQUNuQzthQUFNO1lBQ0wsTUFBTSxDQUFDLElBQUksQ0FBQyxLQUFLLEVBQUUsZ0NBQWdDLENBQUMsQ0FBQTtZQUNwRCxNQUFNLElBQUksQ0FBQyxvQkFBb0IsRUFBRSxDQUFBO1NBQ2xDO0lBQ0gsQ0FBQztDQUNGIn0=
|
package/package.json
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@simple-release/github-action",
|
|
3
|
+
"type": "module",
|
|
4
|
+
"version": "2.0.0",
|
|
5
|
+
"description": "A simple-release api for github action.",
|
|
6
|
+
"author": {
|
|
7
|
+
"name": "Dan Onoshko",
|
|
8
|
+
"email": "danon0404@gmail.com",
|
|
9
|
+
"url": "https://github.com/dangreen"
|
|
10
|
+
},
|
|
11
|
+
"license": "MIT",
|
|
12
|
+
"homepage": "https://github.com/TrigenSoftware/simple-release/tree/master/packages/github-action#readme",
|
|
13
|
+
"funding": "https://ko-fi.com/dangreen",
|
|
14
|
+
"repository": {
|
|
15
|
+
"type": "git",
|
|
16
|
+
"url": "https://github.com/TrigenSoftware/simple-release.git",
|
|
17
|
+
"directory": "packages/github-action"
|
|
18
|
+
},
|
|
19
|
+
"bugs": {
|
|
20
|
+
"url": "https://github.com/TrigenSoftware/simple-release/issues"
|
|
21
|
+
},
|
|
22
|
+
"keywords": [
|
|
23
|
+
"simple-release",
|
|
24
|
+
"github",
|
|
25
|
+
"github-action",
|
|
26
|
+
"release",
|
|
27
|
+
"changelog"
|
|
28
|
+
],
|
|
29
|
+
"engines": {
|
|
30
|
+
"node": ">=18"
|
|
31
|
+
},
|
|
32
|
+
"exports": {
|
|
33
|
+
"types": "./dist/index.d.ts",
|
|
34
|
+
"import": "./dist/index.js"
|
|
35
|
+
},
|
|
36
|
+
"files": [
|
|
37
|
+
"dist"
|
|
38
|
+
],
|
|
39
|
+
"dependencies": {
|
|
40
|
+
"@actions/github": "^6.0.1",
|
|
41
|
+
"@simple-release/config": "^2.0.0",
|
|
42
|
+
"@simple-release/core": "^2.0.0",
|
|
43
|
+
"@simple-release/github": "^2.0.0"
|
|
44
|
+
}
|
|
45
|
+
}
|