diff --git a/.github/workflows/versions.yml b/.github/workflows/versions.yml index b459c8aa..7d79b9e8 100644 --- a/.github/workflows/versions.yml +++ b/.github/workflows/versions.yml @@ -6,7 +6,7 @@ on: - '**.md' push: branches: - - main + - main - releases/* paths-ignore: - '**.md' diff --git a/README.md b/README.md index ba0da887..8458eeaf 100644 --- a/README.md +++ b/README.md @@ -4,33 +4,18 @@ build-test status versions status proxy status

-This action sets by node environment for use in actions by: +This action provides the following functionality for GitHub Actions runners: -- optionally downloading and caching a version of node - npm by version spec and add to PATH -- registering problem matchers for error output -- configuring authentication for GPR or npm - -# v2 - -This release adds reliability for pulling node distributions from a cache of node releases. - -```yaml -steps: -- uses: actions/checkout@v2 -- uses: actions/setup-node@v2 - with: - node-version: '14' -``` - -The action will first check the local cache for a semver match. The hosted images have been updated with the latest of each LTS from v8, v10, v12, and v14. `self-hosted` machines will benefit from the cache as well only downloading once. The action will pull LTS versions from [node-versions releases](https://github.com/actions/node-versions/releases) and on miss or failure will fall back to the previous behavior of downloading directly from [node dist](https://nodejs.org/dist/). - -The `node-version` input is optional. If not supplied, the node version that is PATH will be used. However, this action will still register problem matchers and support auth features. So setting up the node environment is still a valid scenario without downloading and caching versions. +- Optionally downloading and caching distribution of the requested Node.js version, and adding it to the PATH +- Optionally caching npm/yarn dependencies +- Registering problem matchers for error output +- Configuring authentication for GPR or npm # Usage See [action.yml](action.yml) -Basic: +**Basic:** ```yaml steps: - uses: actions/checkout@v2 @@ -41,13 +26,15 @@ steps: - run: npm test ``` -Check latest version: +The `node-version` input is optional. If not supplied, the node version from PATH will be used. However, this action will still register problem matchers and support auth features. So setting up the node environment is still a valid scenario without downloading and caching versions. -In the basic example above, the `check-latest` flag defaults to `false`. When set to `false`, the action tries to first resolve a version of node from the local cache. For information regarding locally cached versions of Node on GitHub hosted runners, check out [GitHub Actions Virtual Environments](https://github.com/actions/virtual-environments). The local version of Node in cache gets updated every couple of weeks. If unable to find a specific version in the cache, the action will then attempt to download a version of Node. Use the default or set `check-latest` to `false` if you prefer stability and if you want to ensure a specific version of Node is always used. +The action will first check the local cache for a semver match. If unable to find a specific version in the cache, the action will attempt to download a version of Node.js. It will pull LTS versions from [node-versions releases](https://github.com/actions/node-versions/releases) and on miss or failure will fall back to the previous behavior of downloading directly from [node dist](https://nodejs.org/dist/). -If `check-latest` is set to `true`, the action first checks if the cached version is the latest one. If the locally cached version is not the most up-to-date, a version of Node will then be downloaded. Set `check-latest` to `true` it you want the most up-to-date version of Node to always be used. +For information regarding locally cached versions of Node.js on GitHub hosted runners, check out [GitHub Actions Virtual Environments](https://github.com/actions/virtual-environments). -> Setting `check-latest` to `true` has performance implications as downloading versions of Node is slower than using cached versions +### Caching packages dependencies + +The action has a built-in functionality for caching and restoring npm/yarn dependencies. Supported package managers are `npm`, `yarn`. The `cache` input is optional, and caching is turned off by default. ```yaml steps: @@ -55,16 +42,31 @@ steps: - uses: actions/setup-node@v2 with: node-version: '14' - check-latest: true + cache: 'npm' - run: npm install - run: npm test ``` -Matrix Testing: +**Caching yarn dependencies:** +```yaml +steps: +- uses: actions/checkout@v2 +- uses: actions/setup-node@v2 + with: + node-version: '14' + cache: 'yarn' +- run: npm install +- run: npm test +``` +Yarn caching handles both yarn versions: 1 or 2. + +> At the moment, only `lock` files in the project root are supported. + +### Matrix Testing: ```yaml jobs: build: - runs-on: ubuntu-16.04 + runs-on: ubuntu-latest strategy: matrix: node: [ '12', '14' ] @@ -78,119 +80,14 @@ jobs: - run: npm install - run: npm test ``` +## Advanced usage -Architecture: - -You can use any of the [supported operating systems](https://docs.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners), and the compatible `architecture` can be selected using `architecture`. Values are `x86`, `x64`, `arm64`, `armv6l`, `armv7l`, `ppc64le`, `s390x` (not all of the architectures are available on all platforms). - -When using `architecture`, `node-version` must be provided as well. -```yaml -jobs: - build: - runs-on: windows-latest - name: Node sample - steps: - - uses: actions/checkout@v2 - - uses: actions/setup-node@v2 - with: - node-version: '14' - architecture: 'x64' # optional, x64 or x86. If not specified, x64 will be used by default - - run: npm install - - run: npm test -``` - -Multiple Operating Systems and Architectures: - -```yaml -jobs: - build: - runs-on: ${{ matrix.os }} - strategy: - matrix: - os: - - ubuntu-latest - - macos-latest - - windows-latest - node_version: - - 10 - - 12 - - 14 - architecture: - - x64 - # an extra windows-x86 run: - include: - - os: windows-2016 - node_version: 12 - architecture: x86 - name: Node ${{ matrix.node_version }} - ${{ matrix.architecture }} on ${{ matrix.os }} - steps: - - uses: actions/checkout@v2 - - name: Setup node - uses: actions/setup-node@v2 - with: - node-version: ${{ matrix.node_version }} - architecture: ${{ matrix.architecture }} - - run: npm install - - run: npm test -``` - -Publish to npmjs and GPR with npm: -```yaml -steps: -- uses: actions/checkout@v2 -- uses: actions/setup-node@v2 - with: - node-version: '10.x' - registry-url: 'https://registry.npmjs.org' -- run: npm install -- run: npm publish - env: - NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} -- uses: actions/setup-node@v2 - with: - registry-url: 'https://npm.pkg.github.com' -- run: npm publish - env: - NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} -``` - -Publish to npmjs and GPR with yarn: -```yaml -steps: -- uses: actions/checkout@v2 -- uses: actions/setup-node@v2 - with: - node-version: '10.x' - registry-url: -- run: yarn install -- run: yarn publish - env: - NODE_AUTH_TOKEN: ${{ secrets.YARN_TOKEN }} -- uses: actions/setup-node@v2 - with: - registry-url: 'https://npm.pkg.github.com' -- run: yarn publish - env: - NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} -``` - -Use private packages: -```yaml -steps: -- uses: actions/checkout@v2 -- uses: actions/setup-node@v2 - with: - node-version: '10.x' - registry-url: 'https://registry.npmjs.org' -# Skip post-install scripts here, as a malicious -# script could steal NODE_AUTH_TOKEN. -- run: npm install --ignore-scripts - env: - NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} -# `npm rebuild` will run all those post-install scripts for us. -- run: npm rebuild && npm run prepare --if-present -``` - +1. [Check latest version](docs/advanced-usage.md#check-latest-version) +2. [Using different architectures](docs/advanced-usage.md#architecture) +3. [Using multiple operating systems and architectures](docs/advanced-usage.md#multiple-operating-systems-and-architectures) +4. [Publishing to npmjs and GPR with npm](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-npm) +5. [Publishing to npmjs and GPR with yarn](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-yarn) +6. [Using private packages](docs/advanced-usage.md#use-private-packages) # License diff --git a/docs/advanced-usage.md b/docs/advanced-usage.md new file mode 100644 index 00000000..c9acacbb --- /dev/null +++ b/docs/advanced-usage.md @@ -0,0 +1,132 @@ +# Advanced usage + +### Check latest version: + +The `check-latest` flag defaults to `false`. When set to `false`, the action will first check the local cache for a semver match. If unable to find a specific version in the cache, the action will attempt to download a version of Node.js. It will pull LTS versions from [node-versions releases](https://github.com/actions/node-versions/releases) and on miss or failure will fall back to the previous behavior of downloading directly from [node dist](https://nodejs.org/dist/). Use the default or set `check-latest` to `false` if you prefer stability and if you want to ensure a specific version of Node.js is always used. + +If `check-latest` is set to `true`, the action first checks if the cached version is the latest one. If the locally cached version is not the most up-to-date, a version of Node.js will then be downloaded. Set `check-latest` to `true` it you want the most up-to-date version of Node.js to always be used. + +> Setting `check-latest` to `true` has performance implications as downloading versions of Node is slower than using cached versions. + +```yaml +steps: +- uses: actions/checkout@v2 +- uses: actions/setup-node@v2 + with: + node-version: '14' + check-latest: true +- run: npm install +- run: npm test +``` + +### Architecture: + +You can use any of the [supported operating systems](https://docs.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners), and the compatible `architecture` can be selected using `architecture`. Values are `x86`, `x64`, `arm64`, `armv6l`, `armv7l`, `ppc64le`, `s390x` (not all of the architectures are available on all platforms). + +When using `architecture`, `node-version` must be provided as well. +```yaml +jobs: + build: + runs-on: windows-latest + name: Node sample + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: '14' + architecture: 'x64' # optional, x64 or x86. If not specified, x64 will be used by default + - run: npm install + - run: npm test +``` + +### Multiple Operating Systems and Architectures: + +```yaml +jobs: + build: + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: + - ubuntu-latest + - macos-latest + - windows-latest + node_version: + - 10 + - 12 + - 14 + architecture: + - x64 + # an extra windows-x86 run: + include: + - os: windows-2016 + node_version: 12 + architecture: x86 + name: Node ${{ matrix.node_version }} - ${{ matrix.architecture }} on ${{ matrix.os }} + steps: + - uses: actions/checkout@v2 + - name: Setup node + uses: actions/setup-node@v2 + with: + node-version: ${{ matrix.node_version }} + architecture: ${{ matrix.architecture }} + - run: npm install + - run: npm test +``` + +### Publish to npmjs and GPR with npm: +```yaml +steps: +- uses: actions/checkout@v2 +- uses: actions/setup-node@v2 + with: + node-version: '14.x' + registry-url: 'https://registry.npmjs.org' +- run: npm install +- run: npm publish + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} +- uses: actions/setup-node@v2 + with: + registry-url: 'https://npm.pkg.github.com' +- run: npm publish + env: + NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} +``` + +### Publish to npmjs and GPR with yarn: +```yaml +steps: +- uses: actions/checkout@v2 +- uses: actions/setup-node@v2 + with: + node-version: '14.x' + registry-url: +- run: yarn install +- run: yarn publish + env: + NODE_AUTH_TOKEN: ${{ secrets.YARN_TOKEN }} +- uses: actions/setup-node@v2 + with: + registry-url: 'https://npm.pkg.github.com' +- run: yarn publish + env: + NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} +``` + +### Use private packages: +```yaml +steps: +- uses: actions/checkout@v2 +- uses: actions/setup-node@v2 + with: + node-version: '14.x' + registry-url: 'https://registry.npmjs.org' +# Skip post-install scripts here, as a malicious +# script could steal NODE_AUTH_TOKEN. +- run: npm install --ignore-scripts + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} +# `npm rebuild` will run all those post-install scripts for us. +- run: npm rebuild && npm run prepare --if-present +```