@cycjimmy/semantic-release-action 4.0.0 → 4.1.0

package/README.md

@@ -18,7 +18,7 @@ GitHub Action for [Semantic Release][semantic-url].
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
     uses: cycjimmy/semantic-release-action@v4
     env:
@@ -27,7 +27,7 @@ steps:
 ```
 
 **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@v3` 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@v4` by setting the parameter `persist-credentials: false`. This credential does not have the required permission to operate on protected branches.
 
 #### Private Packages
 
@@ -53,7 +53,8 @@ then make sure that you configure this in your `package.json` file:
 |        ci         |  false   | Whether to run semantic release with CI support. [[Details](#ci)]<br>Support for **semantic-release above v16**.         |
 |      extends      |  false   | Use a sharable configuration [[Details](#extends)]                                                                       |
 | working_directory |  false   | Use another working directory for semantic release [[Details](#working_directory)]                                       |
-|     tag_format    |  false   | Specify format of tag (useful for monorepos)                                                                             |
+|    tag_format     |  false   | Specify format of tag (useful for monorepos)                                                                             |
+|  repository_url   |  false   | The Git repository url. If no repository url specified, current repository will be used by default.                      |
 
 #### semantic_version
 > {Optional Input Parameter} Specify version range for semantic-release.
@@ -61,13 +62,13 @@ then make sure that you configure this in your `package.json` file:
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
     uses: cycjimmy/semantic-release-action@v4
     with:
       semantic_version: 19.0.5  # It is recommended to specify a version range
                                 # for semantic-release when using
-                                # semantic-release-action lower than @v3
+                                # semantic-release-action lower than @v4
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
@@ -81,7 +82,7 @@ If no version range is specified with `cycjimmy/semantic-release-action@v4` then
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
     uses: cycjimmy/semantic-release-action@v4
     with:
@@ -127,7 +128,7 @@ See [configuration#branches](https://semantic-release.gitbook.io/semantic-releas
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
     uses: cycjimmy/semantic-release-action@v4
     with:
@@ -152,7 +153,7 @@ Github Action Workflow:
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
     uses: cycjimmy/semantic-release-action@v4
     with:
@@ -182,7 +183,7 @@ Release Config:
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
     uses: cycjimmy/semantic-release-action@v4
     with:
@@ -198,7 +199,7 @@ steps:
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
     uses: cycjimmy/semantic-release-action@v4
     with:
@@ -216,7 +217,7 @@ The action can be used with `extends` option to extend an existing [sharable con
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
     uses: cycjimmy/semantic-release-action@v4
     with:
@@ -236,7 +237,7 @@ This action run semantic release in the github provided workspace by default. Yo
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
     uses: cycjimmy/semantic-release-action@v4
     with:
@@ -253,7 +254,7 @@ The default tag format on semantic-release is `v{version}`. You can override tha
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
     uses: cycjimmy/semantic-release-action@v4
     with:
@@ -283,7 +284,7 @@ steps:
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
     uses: cycjimmy/semantic-release-action@v4
     id: semantic   # Need an `id` for output variables

package/action.yml

@@ -32,6 +32,9 @@ inputs:
   tag_format:
     required: false
     description: 'The default tag format on semantic-release is v{version}. You can override that behavior using this option.'
+  repository_url:
+    required: false
+    description: 'The Git repository url. If no repository url specified, current repository will be used by default.'
 outputs:
   new_release_published:
     description: 'Whether a new release was published'

package/docs/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [4.1.0](https://github.com/cycjimmy/semantic-release-action/compare/v4.0.0...v4.1.0) (2024-03-19)
+
+
+### Bug Fixes
+
+* fix syntax error for importing ([4297675](https://github.com/cycjimmy/semantic-release-action/commit/42976755bc1a5e38051e756e3a2344ea8f354379))
+
+
+### Features
+
+* add repository_url input ([8dffec4](https://github.com/cycjimmy/semantic-release-action/commit/8dffec4efa886f02052787d688bfccb2e9983b1a))
+
 # [4.0.0](https://github.com/cycjimmy/semantic-release-action/compare/v3.4.2...v4.0.0) (2023-08-31)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cycjimmy/semantic-release-action",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "GitHub Action for Semantic Release",
   "main": "index.js",
   "scripts": {
@@ -25,6 +25,6 @@
     "@cycjimmy/awesome-js-funcs": "^4.0.9",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "semantic-release": "^21.1.1"
+    "semantic-release": "^23.0.5"
   }
 }

package/src/handleOptions.js

@@ -116,3 +116,18 @@ exports.handleTagFormat = () => {
     return {};
   }
 };
+
+/**
+ * Handle repository-url Option
+ * @returns {{}|{r: String}}
+ */
+exports.handleRepositoryUrlOption = () => {
+  const repositoryUrl = core.getInput(inputs.repository_url);
+  core.debug(`repository_url input: ${repositoryUrl}`);
+
+  if (repositoryUrl) {
+    return { r: repositoryUrl }; 
+  } else {
+    return {};
+  }
+};

package/src/index.js

@@ -5,6 +5,7 @@ const {
   handleCiOption,
   handleExtends,
   handleTagFormat,
+  handleRepositoryUrlOption,
 } = require('./handleOptions');
 const setUpJob = require('./setUpJob.task');
 const installSpecifyingVersionSemantic = require('./installSpecifyingVersionSemantic.task');
@@ -32,7 +33,8 @@ const release = async () => {
     ...handleDryRunOption(),
     ...handleCiOption(),
     ...handleExtends(),
-    ...handleTagFormat()
+    ...handleTagFormat(),
+    ...handleRepositoryUrlOption()
   });
 
   await cleanupNpmrc();

package/src/inputs.json

@@ -7,5 +7,6 @@
   "ci": "ci",
   "extends": "extends",
   "working_directory": "working_directory",
-  "tag_format": "tag_format"
+  "tag_format": "tag_format",
+  "repository_url": "repository_url"
 }