@cycjimmy/semantic-release-action 3.0.0 → 3.1.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/README.md +22 -20
- package/docs/CHANGELOG.md +7 -0
- package/package.json +3 -3
- package/src/handleOptions.js +6 -2
package/README.md
CHANGED
|
@@ -43,15 +43,15 @@ then make sure that you configure this in your `package.json` file:
|
|
|
43
43
|
```
|
|
44
44
|
|
|
45
45
|
### Inputs
|
|
46
|
-
|
|
|
47
|
-
|
|
48
|
-
| semantic_version |
|
|
49
|
-
|
|
|
50
|
-
|
|
|
51
|
-
|
|
|
52
|
-
|
|
|
53
|
-
|
|
|
54
|
-
| working_directory |
|
|
46
|
+
| Input Parameter | Required | Description |
|
|
47
|
+
|:-----------------:|:--------:|--------------------------------------------------------------------------------------------------------------------------|
|
|
48
|
+
| semantic_version | false | Specify specifying version range for semantic-release. [[Details](#semantic_version)] |
|
|
49
|
+
| branches | false | The branches on which releases should happen.[[Details](#branches)]<br>Support for **semantic-release above v16**. |
|
|
50
|
+
| branch | false | The branch on which releases should happen.[[Details](#branch)]<br>Only support for **semantic-release older than v16**. |
|
|
51
|
+
| extra_plugins | false | Extra plugins for pre-install. [[Details](#extra_plugins)] |
|
|
52
|
+
| dry_run | false | Whether to run semantic release in `dry-run` mode. [[Details](#dry_run)] |
|
|
53
|
+
| extends | false | Use a sharable configuration [[Details](#extends)] |
|
|
54
|
+
| working_directory | false | Use another working directory for semantic release [[Details](#working_directory)] |
|
|
55
55
|
|
|
56
56
|
#### semantic_version
|
|
57
57
|
> {Optional Input Parameter} Specify specifying version range for semantic-release.<br>If no version range is specified, latest version will be used by default.
|
|
@@ -200,8 +200,10 @@ steps:
|
|
|
200
200
|
uses: cycjimmy/semantic-release-action@v3
|
|
201
201
|
with:
|
|
202
202
|
# You can extend an existing shareable configuration.
|
|
203
|
+
# And you can specify version range for the shareable configuration if you prefer.
|
|
203
204
|
extends: |
|
|
204
|
-
@semantic-release/apm-config
|
|
205
|
+
@semantic-release/apm-config@^9.0.0
|
|
206
|
+
@mycompany/override-config
|
|
205
207
|
env:
|
|
206
208
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
207
209
|
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
@@ -225,16 +227,16 @@ steps:
|
|
|
225
227
|
```
|
|
226
228
|
|
|
227
229
|
### Outputs
|
|
228
|
-
|
|
|
229
|
-
|
|
230
|
-
|
|
|
231
|
-
|
|
|
232
|
-
| new_release_major_version | Major version of the new release. (e.g. `1`)
|
|
233
|
-
| new_release_minor_version | Minor version of the new release. (e.g. `3`)
|
|
234
|
-
| new_release_patch_version | Patch version of the new release. (e.g. `0`)
|
|
235
|
-
|
|
|
236
|
-
|
|
|
237
|
-
|
|
|
230
|
+
| Output Parameter | Description |
|
|
231
|
+
|:-------------------------:|-----------------------------------------------------------------------------------------------------------------------------------|
|
|
232
|
+
| new_release_published | Whether a new release was published. The return value is in the form of a string. (`"true"` or `"false"`) |
|
|
233
|
+
| new_release_version | Version of the new release. (e.g. `"1.3.0"`) |
|
|
234
|
+
| new_release_major_version | Major version of the new release. (e.g. `"1"`) |
|
|
235
|
+
| new_release_minor_version | Minor version of the new release. (e.g. `"3"`) |
|
|
236
|
+
| new_release_patch_version | Patch version of the new release. (e.g. `"0"`) |
|
|
237
|
+
| new_release_channel | The distribution channel on which the last release was initially made available (undefined for the default distribution channel). |
|
|
238
|
+
| new_release_notes | The release notes for the new release. |
|
|
239
|
+
| last_release_version | Version of the previous release, if there was one. (e.g. `"1.2.0"`) |
|
|
238
240
|
|
|
239
241
|
#### Using Output Variables:
|
|
240
242
|
```yaml
|
package/docs/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
# [3.1.0](https://github.com/cycjimmy/semantic-release-action/compare/v3.0.0...v3.1.0) (2022-08-05)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Features
|
|
5
|
+
|
|
6
|
+
* handle versioned extends inputs correctly ([4a51b9f](https://github.com/cycjimmy/semantic-release-action/commit/4a51b9fada7267737750fded8b8edfb275acbbbb))
|
|
7
|
+
|
|
1
8
|
# [3.0.0](https://github.com/cycjimmy/semantic-release-action/compare/v2.7.0...v3.0.0) (2022-03-03)
|
|
2
9
|
|
|
3
10
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cycjimmy/semantic-release-action",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.1.0",
|
|
4
4
|
"description": "GitHub Action for Semantic Release",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -22,9 +22,9 @@
|
|
|
22
22
|
"homepage": "https://github.com/cycjimmy/semantic-release-action#readme",
|
|
23
23
|
"dependencies": {
|
|
24
24
|
"@actions/core": "^1.6.0",
|
|
25
|
-
"@cycjimmy/awesome-js-funcs": "^
|
|
25
|
+
"@cycjimmy/awesome-js-funcs": "^4.0.4",
|
|
26
26
|
"@semantic-release/changelog": "^6.0.1",
|
|
27
27
|
"@semantic-release/git": "^10.0.1",
|
|
28
|
-
"semantic-release": "^19.0.
|
|
28
|
+
"semantic-release": "^19.0.3"
|
|
29
29
|
}
|
|
30
30
|
}
|
package/src/handleOptions.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
const core = require('@actions/core');
|
|
2
|
-
const stringToJson = require('@cycjimmy/awesome-js-funcs/cjs/typeConversion/stringToJson').default;
|
|
2
|
+
const stringToJson = require('@cycjimmy/awesome-js-funcs/cjs/typeConversion/stringToJson.cjs').default;
|
|
3
3
|
const inputs = require('./inputs.json');
|
|
4
4
|
|
|
5
5
|
/**
|
|
@@ -68,7 +68,11 @@ exports.handleExtends = () => {
|
|
|
68
68
|
const extend = core.getInput(inputs.extends);
|
|
69
69
|
|
|
70
70
|
if (extend) {
|
|
71
|
-
|
|
71
|
+
const extendModuleNames = extend.split(/\r?\n/)
|
|
72
|
+
.map((name) => name.replace(/(?<!^)@.+/, ''))
|
|
73
|
+
return {
|
|
74
|
+
extends: extendModuleNames
|
|
75
|
+
};
|
|
72
76
|
} else {
|
|
73
77
|
return {};
|
|
74
78
|
}
|