Create blank.yml #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# This is a basic workflow to help you get started with Actions | ||
name: CI | ||
# Controls when the workflow will run | ||
on: | ||
# Triggers the workflow on push or pull request events but only for the "main" branch | ||
push: | ||
branches: [ "main" ] | ||
pull_request: | ||
branches: [ "main" ] | ||
# Allows you to run this workflow manually from the Actions tab | ||
workflow_dispatch: | ||
# A workflow run is made up of one or more jobs that can run sequentially or in parallel | ||
jobs: | ||
# This workflow contains a single job called "build" | ||
build: | ||
# The type of runner that the job will run on | ||
runs-on: ubuntu-latest | ||
# Steps represent a sequence of tasks that will be executed as part of the job | ||
steps: | ||
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | ||
- uses: actions/checkout@v4 | ||
# Runs a single command using the runners shell | ||
- name: Run a one-line script | ||
run: echo Hello, world! | ||
# Runs a set of commands using the runners shell | ||
- name: Run a multi-line script | ||
run: | | ||
echo Add other actions to build, | ||
echo test, and deploy your project. | ||
name: 'Setup Node.js environment' | ||
description: 'Setup a Node.js environment by adding problem matchers and optionally downloading and adding it to the PATH.' | ||
author: 'GitHub' | ||
inputs: | ||
always-auth: | ||
description: 'Set always-auth in npmrc.' | ||
default: 'false' | ||
node-version: | ||
description: 'Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0.' | ||
node-version-file: | ||
description: 'File containing the version Spec of the version to use. Examples: package.json, .nvmrc, .node-version, .tool-versions.' | ||
architecture: | ||
description: 'Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.' | ||
check-latest: | ||
description: 'Set this option if you want the action to check for the latest available version that satisfies the version spec.' | ||
default: false | ||
registry-url: | ||
description: 'Optional registry to set up for auth. Will set the registry in a project level .npmrc and .yarnrc file, and set up auth to read in from env.NODE_AUTH_TOKEN.' | ||
scope: | ||
description: 'Optional scope for authenticating against scoped registries. Will fall back to the repository owner when using the GitHub Packages registry (https://npm.pkg.github.com/).' | ||
token: | ||
description: Used to pull node distributions from node-versions. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting. | ||
default: ${{ github.server_url == 'https://github.com' && github.token || '' }} | ||
cache: | ||
description: 'Used to specify a package manager for caching in the default directory. Supported values: npm, yarn, pnpm.' | ||
cache-dependency-path: | ||
description: 'Used to specify the path to a dependency file: package-lock.json, yarn.lock, etc. Supports wildcards or a list of file names for caching multiple dependencies.' | ||
# TODO: add input to control forcing to pull from cloud or dist. | ||
# escape valve for someone having issues or needing the absolute latest which isn't cached yet | ||
outputs: | ||
cache-hit: | ||
description: 'A boolean value to indicate if a cache was hit.' | ||
node-version: | ||
description: 'The installed node version.' | ||
runs: | ||
using: 'node20' | ||
main: 'dist/setup/index.js' | ||
post: 'dist/cache-save/index.js' | ||
post-if: success() |