Skip to content

Commit

Permalink
Merge pull request #183 from jpbnetley/bugfix/readme
Browse files Browse the repository at this point in the history
docs: update readme to ref checkout@v4
  • Loading branch information
cycjimmy committed Nov 9, 2023
2 parents 9420870 + 86915db commit ddb03b6
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
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@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

Expand Down Expand Up @@ -61,7 +61,7 @@ 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:
Expand All @@ -81,7 +81,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:
Expand Down Expand Up @@ -127,7 +127,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:
Expand All @@ -152,7 +152,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:
Expand Down Expand Up @@ -182,7 +182,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:
Expand All @@ -198,7 +198,7 @@ steps:
```yaml
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Semantic Release
uses: cycjimmy/semantic-release-action@v4
with:
Expand All @@ -216,7 +216,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:
Expand All @@ -236,7 +236,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:
Expand All @@ -253,7 +253,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:
Expand Down Expand Up @@ -283,7 +283,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
Expand Down

0 comments on commit ddb03b6

Please sign in to comment.