Clarifications to the README (#167)

* Update README.md

* Update README.md

Co-authored-by: Bryan MacFarlane <bryanmacfarlane@github.com>

.gitattributes

@@ -1 +0,0 @@
-.licenses/** -diff linguist-generated=true

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +0,0 @@
----
-name: Bug report
-about: Create a bug report
-title: ''
-labels: bug, needs triage
-assignees: ''
-
----
-
-<!--- Please direct any generic questions related to actions to our support community forum at https://github.community/c/code-to-cloud/github-actions/41 --->
-<!--- Before opening up a new bug report, please make sure to check for similar existing issues -->
-
-**Description:**
-A clear and concise description of what the bug is.
-
-**Action version:**
-Specify the action version
-
-**Platform:**
-- [ ] Ubuntu
-- [ ] macOS
-- [ ] Windows
-
-**Runner type:**
-- [ ] Hosted
-- [ ] Self-hosted
-
-**Tools version:**
-<!--- Please specify versions of node and package manager (npm, yarn, pnpm and etc)-->
-
-**Repro steps:**  
-A description with steps to reproduce the issue. If you have a public example or repo to share, please provide the link.
-
-**Expected behavior:**
-A description of what you expected to happen.
-
-**Actual behavior:**
-A description of what is actually happening.

.github/ISSUE_TEMPLATE/config.yml

@@ -1 +0,0 @@
-blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,18 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: feature request, needs triage
-assignees: ''
----
-<!--- Please direct any generic questions related to actions to our support community forum at https://github.community/c/code-to-cloud/github-actions/41 --->
-<!--- Before opening up a new feature request, please make sure to check for similar existing issues and pull requests -->
-
-**Description:**
-Describe your proposal.
-
-**Justification:**
-Justification or a use case for your proposal.
-
-**Are you willing to submit a PR?**
-<!--- We accept contributions! -->

.github/pull_request_template.md

@@ -1,9 +0,0 @@
-**Description:**
-Describe your changes.
-
-**Related issue:**
-Add link to the related issue.
-
-**Check list:**
-- [ ] Mark if documentation changes are required.
-- [ ] Mark if tests were added or updated to cover the changes.

.github/tsc.json

@@ -4,15 +4,14 @@
             "owner": "tsc",
             "pattern": [
                 {
-                    "regexp": "^([^\\s].*)[\\(:](\\d+)[,:](\\d+)(?:\\):\\s+|\\s+-\\s+)(error|warning|info)\\s+TS(\\d+)\\s*:\\s*(.*)$",
+                    "regexp": "^(?:\\s+\\d+\\>)?([^\\s].*)\\((\\d+|\\d+,\\d+|\\d+,\\d+,\\d+,\\d+)\\)\\s*:\\s+(error|warning|info)\\s+(\\w{1,2}\\d+)\\s*:\\s*(.*)$",
                     "file": 1,
-                    "line": 2,
-                    "column": 3,
-                    "severity": 4,
-                    "code": 5,
-                    "message": 6
+                    "location": 2,
+                    "severity": 3,
+                    "code": 4,
+                    "message": 5
                 }
             ]
         }
     ]
-}
+}

.github/workflows/build-test.yml

@@ -3,28 +3,30 @@ name: build-test
 on:
   pull_request:
     paths-ignore:
-      - '**.md'
-  push:
+      - '**.md'    
+  push:    
     branches:
-      - main
+      - master
       - releases/*
     paths-ignore:
       - '**.md'
-
+      
 jobs:
   build:
-    runs-on: ${{ matrix.os }}
+    runs-on: ${{ matrix.operating-system }}
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        operating-system: [ubuntu-latest, windows-latest, macos-latest]
     steps:
-      - uses: actions/checkout@v3
-      - name: Setup Node 16.x
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v2
+      - name: Setup node 12
+        uses: actions/setup-node@v1
         with:
-          node-version: 16.x
-          cache: npm
+          node-version: 12.x
       - run: npm ci
       - run: npm run build
       - run: npm run format-check
       - run: npm test
+      - name: Verify no unstaged changes
+        if: runner.os != 'windows'
+        run: __tests__/verify-no-unstaged-changes.sh

.github/workflows/check-dist.yml

@@ -1,52 +0,0 @@
-# `dist/index.js` is a special file in Actions.
-# When you reference an action with `uses:` in a workflow,
-# `index.js` is the code that will run.
-# For our project, we generate this file through a build process from other source files.
-# We need to make sure the checked-in `index.js` actually matches what we expect it to be.
-name: Check dist/
-
-on:
-  push:
-    branches:
-      - main
-    paths-ignore:
-      - '**.md'
-  pull_request:
-    paths-ignore:
-      - '**.md'
-  workflow_dispatch:
-
-jobs:
-  check-dist:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Setup Node 16.x
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16.x
-          cache: npm
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Rebuild the dist/ directory
-        run: npm run build
-
-      - name: Compare the expected and actual dist/ directories
-        run: |
-          if [ "$(git diff --ignore-space-at-eol dist/ | wc -l)" -gt "0" ]; then
-            echo "Detected uncommitted changes after build.  See status below:"
-            git diff
-            exit 1
-          fi
-        id: diff
-
-      # If index.js was different than expected, upload the expected version as an artifact
-      - uses: actions/upload-artifact@v3
-        if: ${{ failure() && steps.diff.conclusion == 'failure' }}
-        with:
-          name: dist
-          path: dist/

.github/workflows/e2e-cache.yml

@@ -1,136 +0,0 @@
-name: e2e-cache
-
-on:
-  pull_request:
-    paths-ignore:
-      - '**.md'
-  push:
-    branches:
-      - main
-      - releases/*
-    paths-ignore:
-      - '**.md'
-
-jobs:
-  node-npm-depencies-caching:
-    name: Test npm (Node ${{ matrix.node-version}}, ${{ matrix.os }})
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [12, 14, 16]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Clean global cache
-        run: npm cache clean --force
-      - name: Setup Node
-        uses: ./
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'npm'
-      - name: Install dependencies
-        run: npm install
-      - name: Verify node and npm
-        run: __tests__/verify-node.sh "${{ matrix.node-version }}"
-        shell: bash
-
-  node-pnpm-depencies-caching:
-    name: Test pnpm (Node ${{ matrix.node-version}}, ${{ matrix.os }})
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [12, 14, 16]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Install pnpm
-        uses: pnpm/action-setup@v2
-        with:
-          version: 6.10.0
-      - name: Generate pnpm file
-        run: pnpm install
-      - name: Remove dependencies
-        shell: pwsh
-        run: Remove-Item node_modules -Force -Recurse
-      - name: Clean global cache
-        run: rm -rf ~/.pnpm-store
-        shell: bash
-      - name: Setup Node
-        uses: ./
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'pnpm'
-      - name: Install dependencies
-        run: pnpm install
-      - name: Verify node and pnpm
-        run: __tests__/verify-node.sh "${{ matrix.node-version }}"
-        shell: bash
-
-  node-yarn1-depencies-caching:
-    name: Test yarn 1 (Node ${{ matrix.node-version}}, ${{ matrix.os }})
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [12, 14, 16]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Yarn version
-        run: yarn --version
-      - name: Generate yarn file
-        run: yarn install
-      - name: Remove dependencies
-        shell: pwsh
-        run: Remove-Item node_modules -Force -Recurse
-      - name: Clean global cache
-        run: yarn cache clean
-      - name: Setup Node
-        uses: ./
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'yarn'
-      - name: Install dependencies
-        run: yarn install
-      - name: Verify node and yarn
-        run: __tests__/verify-node.sh "${{ matrix.node-version }}"
-        shell: bash
-
-  node-yarn2-depencies-caching:
-    name: Test yarn 2 (Node ${{ matrix.node-version}}, ${{ matrix.os }})
-    runs-on: ${{ matrix.os }}
-    env:
-      YARN_ENABLE_IMMUTABLE_INSTALLS: false
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [12, 14, 16]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Update yarn
-        run: yarn set version berry
-      - name: Yarn version
-        run: yarn --version
-      - name: Generate simple .yarnrc.yml
-        run: |
-          echo "nodeLinker: node-modules" >> .yarnrc.yml
-      - name: Generate yarn file
-        run: yarn install
-      - name: Remove dependencies
-        shell: pwsh
-        run: Remove-Item node_modules -Force -Recurse
-      - name: Clean global cache
-        run: yarn cache clean --all
-      - name: Setup Node
-        uses: ./
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'yarn'
-      - name: Install dependencies
-        run: yarn install
-      - name: Verify node and yarn
-        run: __tests__/verify-node.sh "${{ matrix.node-version }}"
-        shell: bash

.github/workflows/licensed.yml

@@ -1,24 +0,0 @@
-name: Licensed
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    name: Check licenses
-    steps:
-      - uses: actions/checkout@v3
-      - run: npm ci
-      - name: Install licensed
-        run: |
-          cd $RUNNER_TEMP
-          curl -Lfs -o licensed.tar.gz https://github.com/github/licensed/releases/download/3.4.4/licensed-3.4.4-linux-x64.tar.gz
-          sudo tar -xzf licensed.tar.gz
-          sudo mv licensed /usr/local/bin/licensed
-      - run: licensed status

.github/workflows/proxy.yml

@@ -3,17 +3,19 @@ name: proxy
 on:
   pull_request:
     paths-ignore:
-      - '**.md'
-  push:
+      - '**.md'    
+  push:    
     branches:
-      - main
+      - master
       - releases/*
     paths-ignore:
       - '**.md'
-
+      
 jobs:
   test-proxy:
     runs-on: ubuntu-latest
+    strategy:    
+      fail-fast: false    
     container:
       image: ubuntu:latest
       options: --dns 127.0.0.1
@@ -25,23 +27,25 @@ jobs:
     env:
       https_proxy: http://squid-proxy:3128
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       - name: Clear tool cache
         run: rm -rf $RUNNER_TOOL_CACHE/*
-      - name: Setup node 14
+      - name: Setup node 10
         uses: ./
         with:
-          node-version: 14.x
+          node-version: 10.x
       - name: Verify node and npm
-        run: __tests__/verify-node.sh 14
+        run: __tests__/verify-node.sh 10
 
   test-bypass-proxy:
     runs-on: ubuntu-latest
+    strategy:    
+      fail-fast: false
     env:
       https_proxy: http://no-such-proxy:3128
       no_proxy: api.github.com,github.com,nodejs.org,registry.npmjs.org,*.s3.amazonaws.com,s3.amazonaws.com
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       - name: Clear tool cache
         run: rm -rf $RUNNER_TOOL_CACHE/*
       - name: Setup node 11

.github/workflows/release-new-action-version.yml

@@ -1,27 +0,0 @@
-name: Release new action version
-on:
-  release:
-    types: [released]
-  workflow_dispatch:
-    inputs:
-      TAG_NAME:
-        description: 'Tag name that the major tag will point to'
-        required: true
-
-env:
-  TAG_NAME: ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }}
-permissions:
-  contents: write
-
-jobs:
-  update_tag:
-    name: Update the major tag to include the ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }} changes
-    environment:
-      name: releaseNewActionVersion
-    runs-on: ubuntu-latest
-    steps:
-    - name: Update the ${{ env.TAG_NAME }} tag
-      uses: actions/publish-action@v0.1.0
-      with:
-        source-tag: ${{ env.TAG_NAME }}
-        slack-webhook: ${{ secrets.SLACK_WEBHOOK }}

.github/workflows/versions.yml

@@ -3,24 +3,24 @@ name: versions
 on:
   pull_request:
     paths-ignore:
-      - '**.md'
-  push:
+      - '**.md'    
+  push:    
     branches:
-      - main
+      - master
       - releases/*
     paths-ignore:
       - '**.md'
-
+      
 jobs:
   local-cache:
-    runs-on: ${{ matrix.os }}
+    runs-on: ${{ matrix.operating-system }}
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        operating-system: [ubuntu-latest, windows-latest, macos-latest]
         node-version: [10, 12, 14]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       - name: Setup Node
         uses: ./
         with:
@@ -29,37 +29,15 @@ jobs:
         run: __tests__/verify-node.sh "${{ matrix.node-version }}"
         shell: bash
 
-  lts-syntax:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [lts/dubnium, lts/erbium, lts/fermium, lts/*, lts/-1]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Setup Node
-        uses: ./
-        with:
-          node-version: ${{ matrix.node-version }}
-          check-latest: true
-      - if: runner.os != 'Windows'
-        name: Verify node and npm
-        run: |
-          . "$NVM_DIR/nvm.sh"
-          [[ $(nvm version-remote "${{ matrix.node-version }}") =~ ^v([^.]+) ]]
-          __tests__/verify-node.sh "${BASH_REMATCH[1]}"
-        shell: bash
-
   manifest:
-    runs-on: ${{ matrix.os }}
+    runs-on: ${{ matrix.operating-system }}
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [10.15, 12.16.0, 14.2.0, 16.3.0]
+        operating-system: [ubuntu-latest, windows-latest, macos-latest]
+        node-version: [10.15, 12.16.0, 14.2.0]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       - name: Setup Node
         uses: ./
         with:
@@ -69,14 +47,14 @@ jobs:
         shell: bash
 
   check-latest:
-    runs-on: ${{ matrix.os }}
+    runs-on: ${{ matrix.operating-system }}
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [10, 12, 14]
+        operating-system: [ubuntu-latest, windows-latest, macos-latest]
+        node-version: [10, 11, 12, 14]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       - name: Setup Node and check latest
         uses: ./
         with:
@@ -86,49 +64,15 @@ jobs:
         run: __tests__/verify-node.sh "${{ matrix.node-version }}"
         shell: bash
 
-  version-file:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version-file: [.nvmrc, .tool-versions, package.json]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Remove volta from package.json
-        shell: bash
-        run: cat <<< "$(jq 'del(.volta)' ./__tests__/data/package.json)" > ./__tests__/data/package.json
-      - name: Setup node from node version file
-        uses: ./
-        with:
-          node-version-file: '__tests__/data/${{ matrix.node-version-file }}'
-      - name: Verify node
-        run: __tests__/verify-node.sh 14
-
-  version-file-volta:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Setup node from node version file
-        uses: ./
-        with:
-          node-version-file: '__tests__/data/package.json'
-      - name: Verify node
-        run: __tests__/verify-node.sh 16
-
   node-dist:
-    runs-on: ${{ matrix.os }}
+    runs-on: ${{ matrix.operating-system }}
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        operating-system: [ubuntu-latest, windows-latest, macos-latest]
         node-version: [11, 13]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       - name: Setup Node from dist
         uses: ./
         with:
@@ -138,13 +82,13 @@ jobs:
         shell: bash
 
   old-versions:
-    runs-on: ${{ matrix.os }}
+    runs-on: ${{ matrix.operating-system }}
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        operating-system: [ubuntu-latest, windows-latest, macos-latest]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       # test old versions which didn't have npm and layout different
       - name: Setup node 0.12.18 from dist
         uses: ./
@@ -152,48 +96,4 @@ jobs:
           node-version: 0.12.18
       - name: Verify node
         run: __tests__/verify-node.sh 0.12.18 SKIP_NPM
-        shell: bash
-
-  arch:
-    runs-on: windows-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Setup node 14 x86 from dist
-        uses: ./
-        with:
-          node-version: '14'
-          architecture: 'x86'
-      - name: Verify node
-        run: __tests__/verify-arch.sh "ia32"
-        shell: bash
-
-  node-latest-aliases:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [current, latest, node]
-    steps:
-      - name: Get node version
-        run: |
-          latestNodeVersion=$(curl https://nodejs.org/dist/index.json | jq -r '. [0].version')
-          echo "::set-output name=LATEST_NODE_VERSION::$latestNodeVersion"
-        id: version
-        shell: bash
-      - uses: actions/checkout@v3
-      - name: Setup Node
-        uses: ./
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Retrieve version after install
-        run: |
-          updatedVersion=$(echo $(node --version))
-          echo "::set-output name=NODE_VERSION_UPDATED::$updatedVersion"
-        id: updatedVersion
-        shell: bash
-      - name: Compare versions
-        if: ${{ steps.version.outputs.LATEST_NODE_VERSION != steps.updatedVersion.outputs.NODE_VERSION_UPDATED}}
-        run: |
-          echo "Latest node version failed to download."
-          exit 1
+        shell: bash

.licensed.yml

@@ -1,15 +0,0 @@
-sources:
-  npm: true
-
-allowed:
-  - apache-2.0
-  - 0bsd
-  - bsd-2-clause
-  - bsd-3-clause
-  - isc
-  - mit
-  - cc0-1.0
-  - unlicense
-
-reviewed:
-  npm: