Merge pull request #232 from arnested/job-summary

Add GitHub Actions Job Summary

Author: arnested

.github/workflows/test.yml

@@ -39,4 +39,4 @@ jobs:
       - run: |
           test '${{ steps.go-version.outputs.latest }}' == '1.18'
       - run: |
-          test '${{ steps.go-version.outputs.matrix }}' == '["1.18","1.17","1.16","1.15","1.14","1.13"]'
+          test '${{ steps.go-version.outputs.matrix }}' == '["1.13","1.14","1.15","1.16","1.17","1.18"]'

README.md

@@ -73,13 +73,14 @@ jobs:
   my-go-workflow:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: arnested/go-version-action@v1
         id: go-version
       - name: Install Go ${{ steps.go-version.outputs.minimal }}
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v3
         with:
           go-version: ${{ steps.go-version.outputs.minimal }}
+          check-latest: true
 ```
 
 ![Log of running action](docs/action-run.png)
@@ -102,7 +103,7 @@ jobs:
     outputs:
       matrix: ${{ steps.versions.outputs.matrix }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - uses: arnested/go-version-action@v1
       id: versions
   test:
@@ -113,13 +114,22 @@ jobs:
       matrix:
         version: ${{ fromJSON(needs.go-versions.outputs.matrix) }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Install Go
-      uses: actions/setup-go@v2
+      uses: actions/setup-go@v3
       with:
         go-version: ${{ matrix.version }}
+        check-latest: true
     - name: go test
       run: go test -v -race -cover -covermode=atomic -coverprofile=coverage.txt ./...
 ```
 
 ![The workflow summary](docs/action-matrix-summary.png)
+
+## Summary
+
+The action writes a [GitHub Actions Job
+Summary](https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/)
+with values it identified:
+
+![Job summary](docs/job-summary.png)

__tests__/main.test.ts

@@ -12,13 +12,13 @@ test('test minimal version', () => {
 })
 
 test('test latest version', () => {
-  expect(latest(['1.18', '1.17', '1.16', '1.15', '1.14', '1.13'])).toEqual(
+  expect(latest(['1.13', '1.14', '1.15', '1.16', '1.17', '1.18'])).toEqual(
     '1.18'
   )
 })
 
 test('test version matrix', () => {
   const t = JSON.parse(fs.readFileSync('__tests__/testdata/dl.json', 'utf8'))
   const m = matrix('1.13', t)
-  expect(m).toEqual(['1.18', '1.17', '1.16', '1.15', '1.14', '1.13'])
+  expect(m).toEqual(['1.13', '1.14', '1.15', '1.16', '1.17', '1.18'])
 })

docs/job-summary.png

@@ -66,7 +66,7 @@ const matrix = (min: string, tags: Version[]): string[] => {
     return v2 !== null && semverGte(v2, minClean)
   })
 
-  return versions
+  return versions.reverse()
 }
 
 const latest = (versions: string[]): string => {

src/go-versions.ts

@@ -32,6 +32,23 @@ async function run(): Promise<void> {
     core.info(`minimal go version: ${min} - from go.mod`)
     core.info(`latest go version: ${lat} - from https://go.dev/dl/`)
     core.info(`go version matrix: ${mat} - from https://go.dev/dl/`)
+
+    const htmlMat = mat
+      .map(v => `<a href="https://go.dev/doc/go${v}">Go ${v}</a>`)
+      .join('<br>')
+
+    await core.summary
+      .addTable([
+        [
+          {data: 'Output', header: true},
+          {data: 'Value', header: true}
+        ],
+        ['Module', `<a href="https://pkg.go.dev/${name}">${name}</a>`],
+        ['Minimal', `<a href="https://go.dev/doc/go${min}">Go ${min}</a>`],
+        ['Latest', `<a href="https://go.dev/doc/go${lat}">Go ${lat}</a>`],
+        ['Matrix', `${htmlMat}`]
+      ])
+      .write()
   } catch (error) {
     core.setFailed((error as Error).message)
   }