From 81a6335488dda28c98429852f45c68cbcbd66c63 Mon Sep 17 00:00:00 2001 From: "Geoffrey.C" Date: Wed, 30 Aug 2023 21:45:17 +0800 Subject: [PATCH] docs: modify docs for v4 --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 133a947..950153b 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ steps: - name: Checkout uses: actions/checkout@v3 - 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 }} @@ -63,7 +63,7 @@ steps: - name: Checkout uses: actions/checkout@v3 - 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 @@ -73,7 +73,7 @@ steps: 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. +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.
`branches` supports for **semantic-release above v16**. @@ -83,7 +83,7 @@ steps: - name: Checkout uses: actions/checkout@v3 - 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,7 +129,7 @@ steps: - name: Checkout uses: actions/checkout@v3 - 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,7 +154,7 @@ steps: - name: Checkout uses: actions/checkout@v3 - 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,7 +184,7 @@ steps: - name: Checkout uses: actions/checkout@v3 - name: Semantic Release - uses: cycjimmy/semantic-release-action@v3 + uses: cycjimmy/semantic-release-action@v4 with: dry_run: true env: @@ -200,7 +200,7 @@ steps: - name: Checkout uses: actions/checkout@v3 - name: Semantic Release - uses: cycjimmy/semantic-release-action@v3 + uses: cycjimmy/semantic-release-action@v4 with: ci: false env: @@ -218,7 +218,7 @@ steps: - name: Checkout uses: actions/checkout@v3 - 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,7 +238,7 @@ steps: - name: Checkout uses: actions/checkout@v3 - 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,7 +255,7 @@ steps: - name: Checkout uses: actions/checkout@v3 - name: Semantic Release - uses: cycjimmy/semantic-release-action@v3 + uses: cycjimmy/semantic-release-action@v4 with: tag_format: custom-v${version} env: @@ -285,7 +285,7 @@ steps: - name: Checkout uses: actions/checkout@v3 - 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 }}