Merge pull request #179 from oscard0m/add-cache-to-node-workflows

ci(workflow): add 'npm' cache for actions/setup-node in .github/workflows

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+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 go version -->
+
+**Repro steps:**  
+A description with steps to reproduce the issue. If your 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

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

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,18 @@
+---
+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

@@ -0,0 +1,9 @@
+**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/workflows/check-dist.yml

@@ -0,0 +1,51 @@
+# `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@v2
+
+      - name: Set Node.js 12.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+
+      - 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@v2
+        if: ${{ failure() && steps.diff.conclusion == 'failure' }}
+        with:
+          name: dist
+          path: dist/

.github/workflows/licensed.yml

@@ -1,8 +1,12 @@
 name: Licensed
 
 on:
-  push: {branches: main}
-  pull_request: {branches: main}
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
   test:
@@ -17,4 +21,4 @@ jobs:
           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
+      - run: licensed status

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

@@ -20,8 +20,8 @@ jobs:
       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 }}
+      - 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

@@ -63,12 +63,14 @@ jobs:
         os: [macos-latest, windows-latest, ubuntu-latest]
         go: [1.7, 1.8.6]
     steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-    - name: setup-go ${{ matrix.go }}
-      uses: ./
-      with:
-        go-version: ${{ matrix.go }}
-    - name: verify go
-      run: __tests__/verify-go.sh ${{ matrix.go }}
-      shell: bash
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: setup-go ${{ matrix.go }}
+        uses: ./
+        with:
+          go-version: ${{ matrix.go }}
+
+      - name: verify go
+        run: __tests__/verify-go.sh ${{ matrix.go }}
+        shell: bash

.github/workflows/workflow.yml

@@ -16,23 +16,24 @@ jobs:
       matrix:
         operating-system: [ubuntu-latest, windows-latest]
     steps:
-    - name: Checkout
-      uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v2
 
-    - name: Setup node 12
-      uses: actions/setup-node@v1
-      with:
-        node-version: 12
+      - name: Setup node 12
+        uses: actions/setup-node@v2
+        with:
+          node-version: 12
+          cache: npm
 
-    - name: npm install
-      run: npm install
+      - name: npm install
+        run: npm install
 
-    - name: Lint
-      run: npm run format-check
+      - name: Lint
+        run: npm run format-check
 
-    - name: npm test
-      run: npm test
+      - name: npm test
+        run: npm test
 
-    - name: audit packages
-      run: npm audit --audit-level=high
-      if: matrix.operating-system == 'ubuntu-latest'
+      - name: audit packages
+        run: npm audit --audit-level=high
+        if: matrix.operating-system == 'ubuntu-latest'

README.md

@@ -21,25 +21,25 @@ The V2 offers:
 
 It will first check the local cache for a version match. If version is not found locally, It will pull it from `main` branch of [go-versions](https://github.com/actions/go-versions/blob/main/versions-manifest.json) repository and on miss or failure, it will fall back to the previous behavior of download directly from [go dist](https://storage.googleapis.com/golang).
 
-Matching by semver spec:
+Matching by [semver spec](https://github.com/npm/node-semver):
 ```yaml
 steps:
-- uses: actions/checkout@v2
-- uses: actions/setup-go@v2
-  with:
-    go-version: '^1.13.1' # The Go version to download (if necessary) and use.
-- run: go version
+  - uses: actions/checkout@v2
+  - uses: actions/setup-go@v2
+    with:
+      go-version: '^1.13.1' # The Go version to download (if necessary) and use.
+  - run: go version
 ```
 
 Matching an unstable pre-release:
 ```yaml
 steps:
-- uses: actions/checkout@v2
-- uses: actions/setup-go@v2
-  with:
-    stable: 'false'
-    go-version: '1.14.0-rc1' # The Go version to download (if necessary) and use.
-- run: go version
+  - uses: actions/checkout@v2
+  - uses: actions/setup-go@v2
+    with:
+      stable: 'false'
+      go-version: '1.14.0-rc1' # The Go version to download (if necessary) and use.
+  - run: go version
 ```
 
 # Usage
@@ -49,11 +49,11 @@ See [action.yml](action.yml)
 Basic:
 ```yaml
 steps:
-- uses: actions/checkout@master
-- uses: actions/setup-go@v1
-  with:
-    go-version: '1.9.3' # The Go version to download (if necessary) and use.
-- run: go run hello.go
+  - uses: actions/checkout@master
+  - uses: actions/setup-go@v2
+    with:
+      go-version: '1.9.3' # The Go version to download (if necessary) and use.
+  - run: go run hello.go
 ```
 
 Matrix Testing:
@@ -68,12 +68,19 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Setup go
-        uses: actions/setup-go@v1
+        uses: actions/setup-go@v2
         with:
           go-version: ${{ matrix.go }}
       - run: go run hello.go
 ```
 
+### Supported version syntax
+The `go-version` input supports the following syntax:
+
+Specific versions: `1.15`, `1.16.1`, `1.17.0-rc2`, `1.16.0-beta1`  
+SemVer's version range syntax: `^1.13.1`  
+For more information about semantic versioning please refer [semver](https://github.com/npm/node-semver) documentation
+
 # License
 
 The scripts and documentation in this project are released under the [MIT License](LICENSE)

__tests__/setup-go.test.ts

@@ -497,6 +497,16 @@ describe('setup-go', () => {
     expect(annotation.message).toBe('undefined: fmt.Printl');
   });
 
+  it('matches on unix path down the tree', async () => {
+    let line = 'foo/main.go:13:2: undefined: fmt.Printl';
+    let annotation = testMatch(line);
+    expect(annotation).toBeDefined();
+    expect(annotation.line).toBe(13);
+    expect(annotation.column).toBe(2);
+    expect(annotation.file).toBe('foo/main.go');
+    expect(annotation.message).toBe('undefined: fmt.Printl');
+  });
+
   it('matches on rooted unix path', async () => {
     let line = '/assert.go:4:1: missing return at end of function';
     let annotation = testMatch(line);

matchers.json

@@ -4,7 +4,7 @@
             "owner": "go",
             "pattern": [
                 {
-                    "regexp": "^\\s*(\\.{0,2}[\\/\\\\].+\\.go):(?:(\\d+):(\\d+):)? (.*)",
+                    "regexp": "^\\s*(.+\\.go):(?:(\\d+):(\\d+):)? (.*)",
                     "file": 1,
                     "line": 2,
                     "column": 3,
@@ -13,4 +13,4 @@
             ]
         }
     ]
-}
+}

package.json

@@ -30,15 +30,15 @@
     "semver": "^6.1.1"
   },
   "devDependencies": {
-    "@types/jest": "^24.0.13",
+    "@types/jest": "^27.0.2",
     "@types/node": "^12.0.4",
     "@types/semver": "^6.0.0",
     "@zeit/ncc": "^0.21.0",
-    "jest": "^25.2.1",
-    "jest-circus": "^24.7.1",
+    "jest": "^27.2.5",
+    "jest-circus": "^27.2.5",
     "nock": "^10.0.6",
     "prettier": "^1.17.1",
-    "ts-jest": "^24.0.2",
+    "ts-jest": "^27.0.5",
     "typescript": "^3.8.3"
   }
 }