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/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

@@ -6,21 +6,21 @@ on:
       - '**.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@v2
       - name: Setup node 12
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v1
         with:
           node-version: 12.x
       - run: npm ci

.github/workflows/e2e-cache.yml

@@ -1,134 +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@v2
-      - 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@v2
-      - 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@v2
-      - 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 }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [12, 14, 16]
-    steps:
-      - uses: actions/checkout@v2
-      - 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,20 +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@v2
-      - run: npm ci
-      - name: Install licensed
-        run: |
-          cd $RUNNER_TEMP
-          curl -Lfs -o licensed.tar.gz https://github.com/github/licensed/releases/download/2.12.2/licensed-2.12.2-linux-x64.tar.gz
-          sudo tar -xzf licensed.tar.gz
-          sudo mv licensed /usr/local/bin/licensed
-      - run: licensed status

.github/workflows/proxy.yml

@@ -30,12 +30,12 @@ jobs:
       - 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

.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

@@ -6,18 +6,18 @@ on:
       - '**.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@v2
@@ -29,27 +29,13 @@ 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/*]
-    steps:
-      - uses: actions/checkout@v2
-      - name: Setup Node
-        uses: ./
-        with:
-          node-version: ${{ matrix.node-version }}
-
   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@v2
       - name: Setup Node
@@ -61,12 +47,12 @@ 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@v2
       - name: Setup Node and check latest
@@ -79,11 +65,11 @@ jobs:
         shell: bash
 
   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@v2
@@ -96,11 +82,11 @@ 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@v2
       # test old versions which didn't have npm and layout different
@@ -110,17 +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@v2
-      - 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
+        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: