Skip to content

Commit

Permalink
docs: upgrade actions/checkout to v3
Browse files Browse the repository at this point in the history
  • Loading branch information
cycjimmy committed Mar 3, 2022
1 parent e878537 commit f6b0ca3
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Expand Up @@ -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:
Expand All @@ -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

Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand All @@ -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
Expand Down

0 comments on commit f6b0ca3

Please sign in to comment.