diff --git a/README.md b/README.md index ffc668d3..284ecbd9 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ 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 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@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 @@ -59,7 +59,7 @@ 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 with: @@ -78,7 +78,7 @@ steps: ```yaml steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Semantic Release uses: cycjimmy/semantic-release-action@v2 with: @@ -124,7 +124,7 @@ 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 with: @@ -149,7 +149,7 @@ Github Action Workflow: ```yaml steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Semantic Release uses: cycjimmy/semantic-release-action@v2 with: @@ -179,7 +179,7 @@ Release Config: ```yaml steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Semantic Release uses: cycjimmy/semantic-release-action@v2 with: @@ -195,7 +195,7 @@ 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 with: @@ -213,7 +213,7 @@ This action run semantic release in the github provided workspace by default. Yo ```yaml steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Semantic Release uses: cycjimmy/semantic-release-action@v2 with: @@ -240,7 +240,7 @@ steps: ```yaml steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Semantic Release uses: cycjimmy/semantic-release-action@v2 id: semantic # Need an `id` for output variables