Skip to content

docs: update GitHub Actions examples to use actions/checkout@v4 and actions/setup-node@v4 #2525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EoinTrial wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update GitHub Actions examples to use actions/checkout@v4 and actions/setup-node@v4 #2525

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/pages/docs/build-platforms/github-actions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ jobs:
runs-on: ubuntu-latest
if: "!contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci')"
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: '0'

- name: Setup Node
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 'lts/*'
cache: 'npm' # or yarn, pnpn
Expand All @@ -49,7 +49,7 @@ If you are publishing to the Github Package Registry you will need to change a f

```yaml
- name: Setup Node
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 'lts/*'
registry-url: "https://npm.pkg.github.com"
Expand All @@ -69,8 +69,8 @@ If you are publishing to the Github Package Registry you will need to change a f
npx auto shipit
```

The `NODE_AUTH_TOKEN` variable is required for the `.npmrc` that `actions/setup-node@v3` sets up.
If you aren't using `actions/setup-node@v3` replace the variable name `NODE_AUTH_TOKEN` with `NPM_TOKEN` and the `.npmrc` `auto` will handle authentication instead.
The `NODE_AUTH_TOKEN` variable is required for the `.npmrc` that `actions/setup-node@v4` sets up.
If you aren't using `actions/setup-node@v4` replace the variable name `NODE_AUTH_TOKEN` with `NPM_TOKEN` and the `.npmrc` `auto` will handle authentication instead.

## Troubleshooting

Expand All @@ -87,7 +87,7 @@ You will need to create a token with admin access to your repo and modify your b

```yaml
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
# Ensure that git uses your token with admin access to the repo
token: ${{ secrets.ADMIN_TOKEN }}
Expand Down