@cycjimmy/semantic-release-action 3.4.2 → 4.1.0

package/README.md

@@ -18,16 +18,16 @@ 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@v3
+    uses: cycjimmy/semantic-release-action@v4
     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@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,21 +62,19 @@ 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@v3
+    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 }}
 ```
 
-If no version range is specified with `cycjimmy/semantic-release-action@v3` then [semantic-release](https://github.com/semantic-release/semantic-release/) version [19.0.5](https://github.com/semantic-release/semantic-release/releases/tag/v19.0.5) is used. Earlier versions of `cycjimmy/semantic-release-action` default to using the latest version of [semantic-release](https://github.com/semantic-release/semantic-release/), so in this case it is recommended to specify version 19 or lower to avoid compatibility issues.
-
-*Note: [Version 20.0.0](https://github.com/semantic-release/semantic-release/releases/tag/v20.0.0) of [semantic-release](https://github.com/semantic-release/semantic-release/) and later is currently incompatible with `cycjimmy/semantic-release-action`, since it requires Node.js 18. GitHub does not provide this environment yet for [JavaScript actions](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-javascript-actions).*
+If no version range is specified with `cycjimmy/semantic-release-action@v4` then [semantic-release](https://github.com/semantic-release/semantic-release/) version [21.1.1](https://github.com/semantic-release/semantic-release/releases/tag/v21.1.1) is used.
 
 #### branches
 > {Optional Input Parameter} The branches on which releases should happen.<br>`branches` supports for **semantic-release above v16**.
@@ -83,9 +82,9 @@ If no version range is specified with `cycjimmy/semantic-release-action@v3` then
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
-    uses: cycjimmy/semantic-release-action@v3
+    uses: cycjimmy/semantic-release-action@v4
     with:
       semantic_version: 16
       # you can set branches for semantic-release above v16.
@@ -129,9 +128,9 @@ 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@v3
+    uses: cycjimmy/semantic-release-action@v4
     with:
       semantic_version: 15.13.28
       # you can set branch for semantic-release older than v16.
@@ -154,9 +153,9 @@ Github Action Workflow:
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
-    uses: cycjimmy/semantic-release-action@v3
+    uses: cycjimmy/semantic-release-action@v4
     with:
       # You can specify specifying version range for the extra plugins if you prefer.
       extra_plugins: |
@@ -184,9 +183,9 @@ Release Config:
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
-    uses: cycjimmy/semantic-release-action@v3
+    uses: cycjimmy/semantic-release-action@v4
     with:
       dry_run: true
     env:
@@ -200,9 +199,9 @@ steps:
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
-    uses: cycjimmy/semantic-release-action@v3
+    uses: cycjimmy/semantic-release-action@v4
     with:
       ci: false
     env:
@@ -218,9 +217,9 @@ 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@v3
+    uses: cycjimmy/semantic-release-action@v4
     with:
       # You can extend an existing shareable configuration.
       # And you can specify version range for the shareable configuration if you prefer.
@@ -238,9 +237,9 @@ 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@v3
+    uses: cycjimmy/semantic-release-action@v4
     with:
       # You can select another working directory like a subdirectory for example.
       working_directory: ./code
@@ -255,11 +254,11 @@ 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@v3
+    uses: cycjimmy/semantic-release-action@v4
     with:
-      tag_format: custom-v{version}
+      tag_format: custom-v${version}
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
@@ -285,9 +284,9 @@ steps:
 ```yaml
 steps:
   - name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
   - name: Semantic Release
-    uses: cycjimmy/semantic-release-action@v3
+    uses: cycjimmy/semantic-release-action@v4
     id: semantic   # Need an `id` for output variables
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

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'
@@ -58,5 +61,5 @@ outputs:
   last_release_git_tag:
     description: 'The Git tag associated with the last release, if there was one.'
 runs:
-  using: 'node16'
+  using: 'node20'
   main: 'index.js'

package/docs/CHANGELOG.md

@@ -1,3 +1,27 @@
+# [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)
+
+
+### Features
+
+* update node version on runner to 20 ([0c20554](https://github.com/cycjimmy/semantic-release-action/commit/0c2055456eeae973aeeb66cf5082061badb3502c))
+
+
+### BREAKING CHANGES
+
+* set the default node version to 20
+
 ## [3.4.2](https://github.com/cycjimmy/semantic-release-action/compare/v3.4.1...v3.4.2) (2023-03-30)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cycjimmy/semantic-release-action",
-  "version": "3.4.2",
+  "version": "4.1.0",
   "description": "GitHub Action for Semantic Release",
   "main": "index.js",
   "scripts": {
@@ -22,9 +22,9 @@
   "homepage": "https://github.com/cycjimmy/semantic-release-action#readme",
   "dependencies": {
     "@actions/core": "^1.10.0",
-    "@cycjimmy/awesome-js-funcs": "^4.0.4",
+    "@cycjimmy/awesome-js-funcs": "^4.0.9",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "semantic-release": "^19.0.5"
+    "semantic-release": "^23.0.5"
   }
 }

package/src/handleOptions.js

@@ -47,6 +47,7 @@ exports.handleBranchesOption = () => {
  */
 exports.handleDryRunOption = () => {
   const dryRun = core.getInput(inputs.dry_run);
+  core.debug(`dryRun input: ${dryRun}`);
 
   switch (dryRun) {
     case 'true':
@@ -66,6 +67,7 @@ exports.handleDryRunOption = () => {
  */
 exports.handleCiOption = () => {
   const ci = core.getInput(inputs.ci);
+  core.debug(`ci input: ${ci}`);
 
   switch (ci) {
     case 'true':
@@ -85,6 +87,7 @@ exports.handleCiOption = () => {
  */
 exports.handleExtends = () => {
   const extend = core.getInput(inputs.extends);
+  core.debug(`extend input: ${extend}`);
 
   if (extend) {
     const extendModuleNames = extend.split(/\r?\n/)
@@ -103,6 +106,7 @@ exports.handleExtends = () => {
  */
 exports.handleTagFormat = () => {
   const tagFormat = core.getInput(inputs.tag_format);
+  core.debug(`citagFormat input: ${tagFormat}`);
 
   if (tagFormat) {
     return {
@@ -112,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');
@@ -26,13 +27,14 @@ const release = async () => {
   await preInstall(core.getInput(inputs.extra_plugins));
   await preInstall(core.getInput(inputs.extends));
 
-  const semanticRelease = require('semantic-release');
-  const result = await semanticRelease({
+  const semanticRelease = await import('semantic-release');
+  const result = await semanticRelease.default({
     ...handleBranchesOption(),
     ...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"
 }

package/src/windUpJob.task.js

@@ -12,7 +12,7 @@ module.exports = async (result) => {
     return Promise.resolve();
   }
 
-  const {lastRelease, commits, nextRelease, releases} = result;
+  const {lastRelease, commits, nextRelease, releases} = await result;
 
   if (lastRelease.version) {
     core.debug(`The last release was "${lastRelease.version}".`);