@cycjimmy/semantic-release-action 2.6.0 → 3.1.0

package/README.md

@@ -18,16 +18,16 @@ GitHub Action for [Semantic Release][semantic-url].
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v2
+    uses: actions/checkout@v3
   - name: Semantic Release
-    uses: cycjimmy/semantic-release-action@v2
+    uses: cycjimmy/semantic-release-action@v3
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 ```
 
 **IMPORTANT**: `GITHUB_TOKEN` does not have the required permissions to operate on protected branches.
-If you are using this action for protected branches, replace `GITHUB_TOKEN` with [Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). If using the `@semantic-release/git` plugin for protected branches, avoid persisting credentials as part of `actions/checkout@v2` by setting the parameter `persist-credentials: false`. This credential does not have the required permission to operate on protected branches.
+If you are using this action for protected branches, replace `GITHUB_TOKEN` with [Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). If using the `@semantic-release/git` plugin for protected branches, avoid persisting credentials as part of `actions/checkout@v3` by setting the parameter `persist-credentials: false`. This credential does not have the required permission to operate on protected branches.
 
 #### Private Packages
 
@@ -43,14 +43,15 @@ then make sure that you configure this in your `package.json` file:
 ```
 
 ### Inputs
-| Input Parameter  | Required | Description |
-|:----------------:|:--------:|-------------|
-| semantic_version | false    | Specify specifying version range for semantic-release. [[Details](#semantic_version)] |
-| branches         | false    | The branches on which releases should happen.[[Details](#branches)]<br>Support for **semantic-release above v16**. |
-| branch           | false    | The branch on which releases should happen.[[Details](#branch)]<br>Only support for **semantic-release older than v16**. |
-| extra_plugins    | false    | Extra plugins for pre-install. [[Details](#extra_plugins)] |
-| dry_run          | false    | Whether to run semantic release in `dry-run` mode. [[Details](#dry_run)] |
-| extends          | false    | Use a sharable configuration [[Details](#extends)] |
+|  Input Parameter  | Required | Description                                                                                                              |
+|:-----------------:|:--------:|--------------------------------------------------------------------------------------------------------------------------|
+| semantic_version  |  false   | Specify specifying version range for semantic-release. [[Details](#semantic_version)]                                    |
+|     branches      |  false   | The branches on which releases should happen.[[Details](#branches)]<br>Support for **semantic-release above v16**.       |
+|      branch       |  false   | The branch on which releases should happen.[[Details](#branch)]<br>Only support for **semantic-release older than v16**. |
+|   extra_plugins   |  false   | Extra plugins for pre-install. [[Details](#extra_plugins)]                                                               |
+|      dry_run      |  false   | Whether to run semantic release in `dry-run` mode. [[Details](#dry_run)]                                                 |
+|      extends      |  false   | Use a sharable configuration [[Details](#extends)]                                                                       |
+| working_directory |  false   | Use another working directory for semantic release [[Details](#working_directory)]                                       |
 
 #### semantic_version
 > {Optional Input Parameter} Specify specifying version range for semantic-release.<br>If no version range is specified, latest version will be used by default.
@@ -58,9 +59,9 @@ then make sure that you configure this in your `package.json` file:
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v2
+    uses: actions/checkout@v3
   - name: Semantic Release
-    uses: cycjimmy/semantic-release-action@v2
+    uses: cycjimmy/semantic-release-action@v3
     with:
       semantic_version: 15.13.28  # It is recommended to specify specifying version range
                                   # for semantic-release.
@@ -77,9 +78,9 @@ steps:
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v2
+    uses: actions/checkout@v3
   - name: Semantic Release
-    uses: cycjimmy/semantic-release-action@v2
+    uses: cycjimmy/semantic-release-action@v3
     with:
       semantic_version: 16
       # you can set branches for semantic-release above v16.
@@ -123,9 +124,9 @@ See [configuration#branches](https://semantic-release.gitbook.io/semantic-releas
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v2
+    uses: actions/checkout@v3
   - name: Semantic Release
-    uses: cycjimmy/semantic-release-action@v2
+    uses: cycjimmy/semantic-release-action@v3
     with:
       semantic_version: 15.13.28
       # you can set branch for semantic-release older than v16.
@@ -148,9 +149,9 @@ Github Action Workflow:
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v2
+    uses: actions/checkout@v3
   - name: Semantic Release
-    uses: cycjimmy/semantic-release-action@v2
+    uses: cycjimmy/semantic-release-action@v3
     with:
       # You can specify specifying version range for the extra plugins if you prefer.
       extra_plugins: |
@@ -178,9 +179,9 @@ Release Config:
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v2
+    uses: actions/checkout@v3
   - name: Semantic Release
-    uses: cycjimmy/semantic-release-action@v2
+    uses: cycjimmy/semantic-release-action@v3
     with:
       dry_run: true
     env:
@@ -194,37 +195,56 @@ The action can be used with `extends` option to extend an existing [sharable con
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v2
+    uses: actions/checkout@v3
   - name: Semantic Release
-    uses: cycjimmy/semantic-release-action@v2
+    uses: cycjimmy/semantic-release-action@v3
     with:
       # You can extend an existing shareable configuration.
+      # And you can specify version range for the shareable configuration if you prefer.
       extends: |
-        @semantic-release/apm-config
+        @semantic-release/apm-config@^9.0.0
+        @mycompany/override-config
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+```
+
+#### working_directory
+This action run semantic release in the github provided workspace by default. You can override it by setting another working directory.
+
+```yaml
+steps:
+  - name: Checkout
+    uses: actions/checkout@v3
+  - name: Semantic Release
+    uses: cycjimmy/semantic-release-action@v3
+    with:
+      # You can select another working directory like a subdirectory for example.
+      working_directory: ./code
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 ```
 
 ### Outputs
-| Output Parameter          | Description |
-|:-------------------------:|---|
-| new_release_published     | Whether a new release was published (`true` or `false`) |
-| new_release_version       | Version of the new release. (e.g. `1.3.0`) |
-| new_release_major_version | Major version of the new release. (e.g. `1`) |
-| new_release_minor_version | Minor version of the new release. (e.g. `3`) |
-| new_release_patch_version | Patch version of the new release. (e.g. `0`) |
-| new_release_channel       | The distribution channel on which the last release was initially made available (undefined for the default distribution channel). |
-| new_release_notes         | The release notes for the new release. |
-| last_release_version      | Version of the previous release, if there was one. (e.g. `1.2.0`) |
+|     Output Parameter      | Description                                                                                                                       |
+|:-------------------------:|-----------------------------------------------------------------------------------------------------------------------------------|
+|   new_release_published   | Whether a new release was published. The return value is in the form of a string. (`"true"` or `"false"`)                         |
+|    new_release_version    | Version of the new release. (e.g. `"1.3.0"`)                                                                                      |
+| new_release_major_version | Major version of the new release. (e.g. `"1"`)                                                                                    |
+| new_release_minor_version | Minor version of the new release. (e.g. `"3"`)                                                                                    |
+| new_release_patch_version | Patch version of the new release. (e.g. `"0"`)                                                                                    |
+|    new_release_channel    | The distribution channel on which the last release was initially made available (undefined for the default distribution channel). |
+|     new_release_notes     | The release notes for the new release.                                                                                            |
+|   last_release_version    | Version of the previous release, if there was one. (e.g. `"1.2.0"`)                                                               |
 
 #### Using Output Variables:
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v2
+    uses: actions/checkout@v3
   - name: Semantic Release
-    uses: cycjimmy/semantic-release-action@v2
+    uses: cycjimmy/semantic-release-action@v3
     id: semantic   # Need an `id` for output variables
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/action.yml

@@ -23,6 +23,9 @@ inputs:
   extends:
     required: false
     description: 'One or several sharable configurations, https://semantic-release.gitbook.io/semantic-release/usage/configuration#extends'
+  working_directory:
+    required: false
+    description: 'Specify another working directory for semantic release. Default one is provided by github.'
 outputs:
   new_release_published:
     description: 'Whether a new release was published'
@@ -38,6 +41,8 @@ outputs:
     description: 'The distribution channel on which the last release was initially made available (undefined for the default distribution channel).'
   new_release_notes:
     description: 'The release notes for the new release.'
+  last_release_version:
+    description: 'Version of the previous release, if there was one.'
 runs:
-  using: 'node12'
+  using: 'node16'
   main: 'index.js'

package/docs/CHANGELOG.md

@@ -1,3 +1,29 @@
+# [3.1.0](https://github.com/cycjimmy/semantic-release-action/compare/v3.0.0...v3.1.0) (2022-08-05)
+
+
+### Features
+
+* handle versioned extends inputs correctly ([4a51b9f](https://github.com/cycjimmy/semantic-release-action/commit/4a51b9fada7267737750fded8b8edfb275acbbbb))
+
+# [3.0.0](https://github.com/cycjimmy/semantic-release-action/compare/v2.7.0...v3.0.0) (2022-03-03)
+
+
+### Features
+
+* switch operating environment to node16 ([b5f16ae](https://github.com/cycjimmy/semantic-release-action/commit/b5f16ae54b21667e3af8a1bd015ec069c8237674)), closes [#92](https://github.com/cycjimmy/semantic-release-action/issues/92) [#96](https://github.com/cycjimmy/semantic-release-action/issues/96)
+
+
+### BREAKING CHANGES
+
+* switch operating environment to node16
+
+# [2.7.0](https://github.com/cycjimmy/semantic-release-action/compare/v2.6.0...v2.7.0) (2021-12-12)
+
+
+### Features
+
+* add working dir ([7126083](https://github.com/cycjimmy/semantic-release-action/commit/71260837fb05623446dee88dd211f7530838b234))
+
 # [2.6.0](https://github.com/cycjimmy/semantic-release-action/compare/v2.5.4...v2.6.0) (2021-10-15)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cycjimmy/semantic-release-action",
-  "version": "2.6.0",
+  "version": "3.1.0",
   "description": "GitHub Action for Semantic Release",
   "main": "index.js",
   "scripts": {
@@ -21,7 +21,10 @@
   },
   "homepage": "https://github.com/cycjimmy/semantic-release-action#readme",
   "dependencies": {
-    "@actions/core": "^1.2.6",
-    "@cycjimmy/awesome-js-funcs": "^2.4.0"
+    "@actions/core": "^1.6.0",
+    "@cycjimmy/awesome-js-funcs": "^4.0.4",
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "semantic-release": "^19.0.3"
   }
 }

package/src/handleOptions.js

@@ -1,5 +1,5 @@
 const core = require('@actions/core');
-const stringToJson = require('@cycjimmy/awesome-js-funcs/typeConversion/stringToJson').default;
+const stringToJson = require('@cycjimmy/awesome-js-funcs/cjs/typeConversion/stringToJson.cjs').default;
 const inputs = require('./inputs.json');
 
 /**
@@ -68,7 +68,11 @@ exports.handleExtends = () => {
   const extend = core.getInput(inputs.extends);
 
   if (extend) {
-    return { extends: extend };
+    const extendModuleNames = extend.split(/\r?\n/)
+      .map((name) => name.replace(/(?<!^)@.+/, ''))
+    return {
+      extends: extendModuleNames
+    };
   } else {
     return {};
   }

package/src/index.js

@@ -16,6 +16,9 @@ const inputs = require('./inputs.json');
  * @returns {Promise<void>}
  */
 const release = async () => {
+  if (core.getInput(inputs.working_directory)) {
+    process.chdir(core.getInput(inputs.working_directory));
+  }
   await setUpJob();
   await installSpecifyingVersionSemantic();
   await preInstall(core.getInput(inputs.extra_plugins));

package/src/inputs.json

@@ -4,5 +4,6 @@
   "branch": "branch",
   "extra_plugins": "extra_plugins",
   "dry_run": "dry_run",
-  "extends": "extends"
+  "extends": "extends",
+  "working_directory": "working_directory"
 }