support http proxy for artifact upload

2023-12-11 18:29:35 -05:00
16 changed files with 158 additions and 439 deletions
@@ -1,3 +1,5 @@
 # Temporarily disabled while v2.0.0 of @actions/artifact is under development
 name: artifact-unit-tests
 on:
  push:
@@ -10,8 +12,8 @@ on:
      - '**.md'
 jobs:
-  upload:
+  build:
-    name: Upload
+    name: Build
    strategy:
      matrix:
@@ -40,13 +42,19 @@ jobs:
        npm run tsc
      working-directory: packages/artifact
    - name: Set artifact file contents
      shell: bash
      run: |
        echo "file1=hello from file 1" >> $GITHUB_ENV
        echo "file2=hello from file 2" >> $GITHUB_ENV
    - name: Create files that will be uploaded
      run: |
        mkdir artifact-path
-        echo -n 'hello from file 1' > artifact-path/first.txt
+        echo '${{ env.file1 }}' > artifact-path/first.txt
-        echo -n 'hello from file 2' > artifact-path/second.txt
+        echo '${{ env.file2 }}' > artifact-path/second.txt
-    - name: Upload Artifacts
+    - name: Upload Artifacts using actions/github-script@v7
      uses: actions/github-script@v7
      with:
        script: |
@@ -65,16 +73,9 @@ jobs:
          console.log(`Successfully uploaded artifact ${id}`)
          try {
            await artifact.uploadArtifact(artifactName, fileContents, './')
            throw new Error('should have failed second upload')
          } catch (err) {
            console.log('Successfully blocked second artifact upload')
          }
  verify:
    name: Verify
    runs-on: ubuntu-latest
-    needs: [upload]
+    needs: [build]
    steps:
    - name: Checkout
      uses: actions/checkout@v4
@@ -95,72 +96,35 @@ jobs:
        npm run tsc
      working-directory: packages/artifact
-    - name: List and Download Artifacts
+    - name: List artifacts using actions/github-script@v7
      uses: actions/github-script@v7
      with:
        script: |
-          const {default: artifactClient} = require('./packages/artifact/lib/artifact')
+          const {default: artifact} = require('./packages/artifact/lib/artifact')
-          const {readFile} = require('fs/promises')
+          const workflowRunId = process.env.GITHUB_RUN_ID
-          const path = require('path')
+          const repository = process.env.GITHUB_REPOSITORY
          const repositoryOwner = repository.split('/')[0]
          const repositoryName = repository.split('/')[1]
-          const findBy = {
+          const listResult = await artifact.listArtifacts(workflowRunId, repositoryOwner, repositoryName, '${{ secrets.GITHUB_TOKEN }}')
            repositoryOwner: process.env.GITHUB_REPOSITORY.split('/')[0],
            repositoryName: process.env.GITHUB_REPOSITORY.split('/')[1],
            token: '${{ secrets.GITHUB_TOKEN }}',
            workflowRunId: process.env.GITHUB_RUN_ID
          }
          const listResult = await artifactClient.listArtifacts({latest: true, findBy})
          console.log(listResult)
          const artifacts = listResult.artifacts
          const expected = [
            'my-artifact-ubuntu-latest',
            'my-artifact-windows-latest',
            'my-artifact-macos-latest'
          ]
-          const foundArtifacts = artifacts.filter(artifact =>
+          if (artifacts.length !== 3) {
-            expected.includes(artifact.name)
+            throw new Error('Expected 3 artifacts but only found ' + artifacts.length + ' artifacts')
-          )
+          }
-          if (foundArtifacts.length !== 3) {
+          const artifactNames = artifacts.map(artifact => artifact.name)
-            console.log('Unexpected length of found artifacts', foundArtifacts)
+          if (!artifactNames.includes('my-artifact-ubuntu-latest')){
-            throw new Error(
+            throw new Error("Expected artifact list to contain an artifact named my-artifact-ubuntu-latest but it's missing")
-              `Expected 3 artifacts but found ${foundArtifacts.length} artifacts.`
+          }
-            )
+          if (!artifactNames.includes('my-artifact-windows-latest')){
            throw new Error("Expected artifact list to contain an artifact named my-artifact-windows-latest but it's missing")
          }
          if (!artifactNames.includes('my-artifact-macos-latest')){
            throw new Error("Expected artifact list to contain an artifact named my-artifact-macos-latest but it's missing")
          }
          console.log('Successfully listed artifacts that were uploaded')
          const files = [
            {name: 'artifact-path/first.txt', content: 'hello from file 1'},
            {name: 'artifact-path/second.txt', content: 'hello from file 2'}
          ]
          for (const artifact of foundArtifacts) {
            const {downloadPath} = await artifactClient.downloadArtifact(artifact.id, {
              path: artifact.name,
              findBy
            })
            console.log('Downloaded artifact to:', downloadPath)
            for (const file of files) {
              const filepath = path.join(
                process.env.GITHUB_WORKSPACE,
                downloadPath,
                file.name
              )
              console.log('Checking file:', filepath)
              const content = await readFile(filepath, 'utf8')
              if (content.trim() !== file.content.trim()) {
                throw new Error(
                  `Expected file '${file.name}' to contain '${file.content}' but found '${content}'`
                )
              }
            }
          }
@@ -5781,9 +5781,9 @@
      }
    },
    "node_modules/follow-redirects": {
-      "version": "1.15.4",
+      "version": "1.15.2",
-      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.4.tgz",
+      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.2.tgz",
-      "integrity": "sha512-Cr4D/5wlrb0z9dgERpUL3LrmPKVDsETIJhaCMeDfuFYcqa5bldGV6wBsAN6X/vxlXQtFBMrXdXxdL8CbDTGniw==",
+      "integrity": "sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA==",
      "dev": true,
      "funding": [
        {
@@ -13,7 +13,7 @@
    "lint": "eslint packages/**/*.ts",
    "lint-fix": "eslint packages/**/*.ts --fix",
    "new-package": "scripts/create-package",
-    "test": "jest --testTimeout 60000"
+    "test": "jest --testTimeout 10000"
  },
  "devDependencies": {
    "@types/jest": "^29.5.4",
@@ -19,7 +19,7 @@ This is the core library that powers the [`@actions/upload-artifact`](https://gi
 ## v2 - What's New
 > [!IMPORTANT]
-> @actions/artifact v2+, upload-artifact@v4+, and download-artifact@v4+ are not currently supported on GHES yet. The previous version of this package can be found at [this tag](https://github.com/actions/toolkit/tree/@actions/artifact@1.1.2/packages/artifact) and [on npm](https://www.npmjs.com/package/@actions/artifact/v/1.1.2).
+> @actions/artifact v2+, upload-artifact@v4+ download-artifact@v4+ are not currently supported on GHES yet. The previous version of this package can be found at [this tag](https://github.com/actions/toolkit/tree/@actions/artifact@1.1.2/packages/artifact) and [on npm](https://www.npmjs.com/package/@actions/artifact/v/1.1.2).
 The release of `@actions/artifact@v2` (including `upload-artifact@v4` and `download-artifact@v4`) are major changes to the backend architecture of Artifacts. They have numerous performance and behavioral improvements.
@@ -63,16 +63,10 @@ Import the module:
 ```js
 // ES6 module
-import {DefaultArtifactClient} from '@actions/artifact'
+import artifact from '@actions/artifact'
 // CommonJS
-const {DefaultArtifactClient} = require('@actions/artifact')
+const {default: artifact} = require('@actions/artifact')
 ```
 Then instantiate:
 ```js
 const artifact = new DefaultArtifactClient()
 ```
 ℹ️ For a comprehensive list of classes, interfaces, functions and more, see the [generated documentation](./docs/generated/README.md).
@@ -97,11 +97,7 @@
 ### 2.0.0
- Major release. Supports new Artifact backend for improved speed, reliability and behavior.
+Major release. Supports new Artifact backend for improved speed, reliability and behavior.
- Numerous API changes, [some breaking](./README.md#breaking-changes).
+Numerous API changes, [some breaking](./README.md#breaking-changes).
- Blog post with more info: TBD
+Blog post with more info: TBD
 ### 2.0.1
 - Patch to fix transient request timeouts https://github.com/actions/download-artifact/issues/249
@@ -4,7 +4,6 @@ import {HttpClient} from '@actions/http-client'
 import * as config from '../src/internal/shared/config'
 import {internalArtifactTwirpClient} from '../src/internal/shared/artifact-twirp-client'
 import {noopLogs} from './common'
 import {NetworkError, UsageError} from '../src/internal/shared/errors'
 jest.mock('@actions/http-client')
@@ -258,42 +257,9 @@ describe('artifact-http-client', () => {
        name: 'artifact',
        version: 4
      })
-    }).rejects.toThrowError(new NetworkError('ENOTFOUND').message)
+    }).rejects.toThrowError(
-    expect(mockHttpClient).toHaveBeenCalledTimes(1)
+      'Failed to CreateArtifact: Unable to make request: ENOTFOUND\nIf you are using self-hosted runners, please make sure your runner has access to all GitHub endpoints: https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github'
-    expect(mockPost).toHaveBeenCalledTimes(1)
+    )
  })
  it('should properly describe a usage error', async () => {
    const mockPost = jest.fn(() => {
      const msgFailed = new http.IncomingMessage(new net.Socket())
      msgFailed.statusCode = 403
      msgFailed.statusMessage = 'Forbidden'
      return {
        message: msgFailed,
        readBody: async () => {
          return Promise.resolve(
            `{"msg": "insufficient usage to create artifact"}`
          )
        }
      }
    })
    const mockHttpClient = (
      HttpClient as unknown as jest.Mock
    ).mockImplementation(() => {
      return {
        post: mockPost
      }
    })
    const client = internalArtifactTwirpClient()
    await expect(async () => {
      await client.CreateArtifact({
        workflowRunBackendId: '1234',
        workflowJobRunBackendId: '5678',
        name: 'artifact',
        version: 4
      })
    }).rejects.toThrowError(new UsageError().message)
    expect(mockHttpClient).toHaveBeenCalledTimes(1)
    expect(mockPost).toHaveBeenCalledTimes(1)
  })
@@ -9,8 +9,7 @@ import archiver from 'archiver'
 import {
  downloadArtifactInternal,
-  downloadArtifactPublic,
+  downloadArtifactPublic
  streamExtractExternal
 } from '../src/internal/download/download-artifact'
 import {getUserAgentString} from '../src/internal/shared/user-agent'
 import {noopLogs} from './common'
@@ -249,44 +248,7 @@ describe('download-artifact', () => {
      })
    })
-    it('should fail if blob storage storage chunk does not respond within 30s', async () => {
+    it('should fail if blob storage response is non-200', async () => {
      // mock http client to delay response data by 30s
      const msg = new http.IncomingMessage(new net.Socket())
      msg.statusCode = 200
      const mockGet = jest.fn(async () => {
        return new Promise((resolve, reject) => {
          // Resolve with a 200 status code immediately
          resolve({
            message: msg,
            readBody: async () => {
              return Promise.resolve(`{"ok": true}`)
            }
          })
          // Reject with an error after 31 seconds
          setTimeout(() => {
            reject(new Error('Request timeout'))
          }, 31000) // Timeout after 31 seconds
        })
      })
      const mockHttpClient = (HttpClient as jest.Mock).mockImplementation(
        () => {
          return {
            get: mockGet
          }
        }
      )
      await expect(
        streamExtractExternal(fixtures.blobStorageUrl, fixtures.workspaceDir)
      ).rejects.toBeInstanceOf(Error)
      expect(mockHttpClient).toHaveBeenCalledWith(getUserAgentString())
    }, 35000) // add longer timeout to allow for timer to run out
    it('should fail if blob storage response is non-200 after 5 retries', async () => {
      const downloadArtifactMock = github.getOctokit(fixtures.token).rest
        .actions.downloadArtifact as MockedDownloadArtifact
      downloadArtifactMock.mockResolvedValueOnce({
@@ -328,60 +290,7 @@ describe('download-artifact', () => {
      expect(mockGetArtifactFailure).toHaveBeenCalledWith(
        fixtures.blobStorageUrl
      )
-      expect(mockGetArtifactFailure).toHaveBeenCalledTimes(5)
+    })
    }, 38000)
    it('should retry if blob storage response is non-200 and then succeed with a 200', async () => {
      const downloadArtifactMock = github.getOctokit(fixtures.token).rest
        .actions.downloadArtifact as MockedDownloadArtifact
      downloadArtifactMock.mockResolvedValueOnce({
        headers: {
          location: fixtures.blobStorageUrl
        },
        status: 302,
        url: '',
        data: Buffer.from('')
      })
      const mockGetArtifact = jest
        .fn(mockGetArtifactSuccess)
        .mockImplementationOnce(mockGetArtifactFailure)
      const mockHttpClient = (HttpClient as jest.Mock).mockImplementation(
        () => {
          return {
            get: mockGetArtifact
          }
        }
      )
      const response = await downloadArtifactPublic(
        fixtures.artifactID,
        fixtures.repositoryOwner,
        fixtures.repositoryName,
        fixtures.token
      )
      expect(downloadArtifactMock).toHaveBeenCalledWith({
        owner: fixtures.repositoryOwner,
        repo: fixtures.repositoryName,
        artifact_id: fixtures.artifactID,
        archive_format: 'zip',
        request: {
          redirect: 'manual'
        }
      })
      expect(mockHttpClient).toHaveBeenCalledWith(getUserAgentString())
      expect(mockGetArtifactFailure).toHaveBeenCalledWith(
        fixtures.blobStorageUrl
      )
      expect(mockGetArtifactFailure).toHaveBeenCalledTimes(1)
      expect(mockGetArtifactSuccess).toHaveBeenCalledWith(
        fixtures.blobStorageUrl
      )
      expect(mockGetArtifactSuccess).toHaveBeenCalledTimes(1)
      expect(response.downloadPath).toBe(fixtures.workspaceDir)
    }, 28000)
  })
  describe('internal', () => {
@@ -352,3 +352,46 @@ describe('upload-artifact', () => {
    expect(uploadResp).rejects.toThrow()
  })
 })
 describe('getBlobClientOptions', () => {
  afterEach(() => {
    delete process.env['HTTPS_PROXY']
    delete process.env['HTTP_PROXY']
    delete process.env['NO_PROXY']
    jest.restoreAllMocks()
  })
  it('should not use proxy settings if not specified', () => {
    const opts = blobUpload.getBlobClientOptions('https://blob-storage.local')
    expect(opts.proxyOptions).toBeUndefined()
  })
  it('should use https proxy settings from environment', () => {
    process.env['HTTPS_PROXY'] = 'https://foo:bar@my-proxy.local'
    const opts = blobUpload.getBlobClientOptions('https://blob-storage.local')
    expect(opts.proxyOptions).toEqual({
      host: 'my-proxy.local',
      port: 443,
      username: 'foo',
      password: 'bar'
    })
  })
  it('should use http proxy settings from environment', () => {
    process.env['HTTP_PROXY'] = 'http://foo:bar@my-proxy.local:1234'
    const opts = blobUpload.getBlobClientOptions('http://blob-storage.local')
    expect(opts.proxyOptions).toEqual({
      host: 'my-proxy.local',
      port: 1234,
      username: 'foo',
      password: 'bar'
    })
  })
  it('should respect NO_PROXY', () => {
    process.env['HTTPS_PROXY'] = 'https://foo:bar@my-proxy.local'
    process.env['NO_PROXY'] = 'no-proxy-me.local'
    const opts = blobUpload.getBlobClientOptions('https://no-proxy-me.local')
    expect(opts.proxyOptions).toBeUndefined()
  })
 })
@@ -1,12 +1,12 @@
 {
  "name": "@actions/artifact",
-  "version": "2.0.1",
+  "version": "2.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "@actions/artifact",
-      "version": "2.0.1",
+      "version": "2.0.0",
      "license": "MIT",
      "dependencies": {
        "@actions/core": "^1.10.0",
@@ -1,6 +1,6 @@
 {
  "name": "@actions/artifact",
-  "version": "2.0.1",
+  "version": "2.0.0",
  "preview": true,
  "description": "Actions artifact lib",
  "keywords": [
@@ -38,65 +38,20 @@ async function exists(path: string): Promise<boolean> {
 }
 async function streamExtract(url: string, directory: string): Promise<void> {
  let retryCount = 0
  while (retryCount < 5) {
    try {
      await streamExtractExternal(url, directory)
      return
    } catch (error) {
      retryCount++
      core.debug(
        `Failed to download artifact after ${retryCount} retries due to ${error.message}. Retrying in 5 seconds...`
      )
      // wait 5 seconds before retrying
      await new Promise(resolve => setTimeout(resolve, 5000))
    }
  }
  throw new Error(`Artifact download failed after ${retryCount} retries.`)
 }
 export async function streamExtractExternal(
  url: string,
  directory: string
 ): Promise<void> {
  const client = new httpClient.HttpClient(getUserAgentString())
  const response = await client.get(url)
  if (response.message.statusCode !== 200) {
    throw new Error(
      `Unexpected HTTP response from blob storage: ${response.message.statusCode} ${response.message.statusMessage}`
    )
  }
  const timeout = 30 * 1000 // 30 seconds
  return new Promise((resolve, reject) => {
    const timerFn = (): void => {
      response.message.destroy(
        new Error(`Blob storage chunk did not respond in ${timeout}ms`)
      )
    }
    const timer = setTimeout(timerFn, timeout)
    response.message
      .on('data', () => {
        timer.refresh()
      })
      .on('error', (error: Error) => {
        core.debug(
          `response.message: Artifact download failed: ${error.message}`
        )
        clearTimeout(timer)
        reject(error)
      })
      .pipe(unzip.Extract({path: directory}))
-      .on('close', () => {
+      .on('close', resolve)
-        clearTimeout(timer)
+      .on('error', reject)
        resolve()
      })
      .on('error', (error: Error) => {
        reject(error)
      })
  })
 }
@@ -4,7 +4,7 @@ import {info, debug} from '@actions/core'
 import {ArtifactServiceClientJSON} from '../../generated'
 import {getResultsServiceUrl, getRuntimeToken} from './config'
 import {getUserAgentString} from './user-agent'
-import {NetworkError, UsageError} from './errors'
+import {NetworkError} from './errors'
 // The twirp http client must implement this interface
 interface Rpc {
@@ -64,7 +64,7 @@ class ArtifactHttpClient implements Rpc {
        this.httpClient.post(url, JSON.stringify(data), headers)
      )
-      return body
+      return JSON.parse(body)
    } catch (error) {
      throw new Error(`Failed to ${method}: ${error.message}`)
    }
@@ -72,49 +72,34 @@ class ArtifactHttpClient implements Rpc {
  async retryableRequest(
    operation: () => Promise<HttpClientResponse>
-  ): Promise<{response: HttpClientResponse; body: object}> {
+  ): Promise<{response: HttpClientResponse; body: string}> {
    let attempt = 0
    let errorMessage = ''
    let rawBody = ''
    while (attempt < this.maxAttempts) {
      let isRetryable = false
      try {
        const response = await operation()
        const statusCode = response.message.statusCode
-        rawBody = await response.readBody()
+        const body = await response.readBody()
        debug(`[Response] - ${response.message.statusCode}`)
        debug(`Headers: ${JSON.stringify(response.message.headers, null, 2)}`)
-        const body = JSON.parse(rawBody)
+        debug(`Body: ${body}`)
        debug(`Body: ${JSON.stringify(body, null, 2)}`)
        if (this.isSuccessStatusCode(statusCode)) {
          return {response, body}
        }
        isRetryable = this.isRetryableHttpStatusCode(statusCode)
        errorMessage = `Failed request: (${statusCode}) ${response.message.statusMessage}`
-        if (body.msg) {
+        const responseMessage = JSON.parse(body).msg
-          if (UsageError.isUsageErrorMessage(body.msg)) {
+        if (responseMessage) {
-            throw new UsageError()
+          errorMessage = `${errorMessage}: ${responseMessage}`
          }
          errorMessage = `${errorMessage}: ${body.msg}`
        }
      } catch (error) {
-        if (error instanceof SyntaxError) {
+        isRetryable = true
-          debug(`Raw Body: ${rawBody}`)
+        errorMessage = error.message
          throw error
        }
        if (error instanceof UsageError) {
          throw error
        }
        if (NetworkError.isNetworkErrorCode(error?.code)) {
          throw new NetworkError(error?.code)
        }
        isRetryable = true
        errorMessage = error.message
      }
      if (!isRetryable) {
@@ -57,16 +57,3 @@ export class NetworkError extends Error {
    ].includes(code)
  }
 }
 export class UsageError extends Error {
  constructor() {
    const message = `Artifact storage quota has been hit. Unable to upload any new artifacts. Usage is recalculated every 6-12 hours.\nMore info on storage limits: https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions#calculating-minute-and-storage-spending`
    super(message)
    this.name = 'UsageError'
  }
  static isUsageErrorMessage = (msg?: string): boolean => {
    if (!msg) return false
    return msg.includes('insufficient usage')
  }
 }
@@ -1,11 +1,18 @@
-import {BlobClient, BlockBlobUploadStreamOptions} from '@azure/storage-blob'
+import {
  AnonymousCredential,
  BlobClient,
  BlockBlobUploadStreamOptions,
  StoragePipelineOptions
 } from '@azure/storage-blob'
 import {TransferProgressEvent} from '@azure/core-http'
 import {ZipUploadStream} from './zip'
 import {getUploadChunkSize, getConcurrency} from '../shared/config'
 import {getProxyUrl} from '@actions/http-client'
 import * as core from '@actions/core'
 import * as crypto from 'crypto'
 import * as stream from 'stream'
 import {NetworkError} from '../shared/errors'
 import {getUserAgentString} from '../shared/user-agent'
 export interface BlobUploadResponse {
  /**
@@ -27,7 +34,12 @@ export async function uploadZipToBlobStorage(
  const maxConcurrency = getConcurrency()
  const bufferSize = getUploadChunkSize()
-  const blobClient = new BlobClient(authenticatedUploadURL)
+
  const blobClient = new BlobClient(
    authenticatedUploadURL,
    new AnonymousCredential(),
    getBlobClientOptions(authenticatedUploadURL)
  )
  const blockBlobClient = blobClient.getBlockBlobClient()
  core.debug(
@@ -85,3 +97,37 @@ export async function uploadZipToBlobStorage(
    sha256Hash
  }
 }
 export function getBlobClientOptions(sasURL: string): StoragePipelineOptions {
  const options: StoragePipelineOptions = {
    userAgentOptions: {
      userAgentPrefix: getUserAgentString()
    }
  }
  const proxyUrl = getProxyUrl(sasURL)
  if (proxyUrl !== '') {
    const {
      port: portString,
      hostname: host,
      username,
      password,
      protocol
    } = new URL(proxyUrl)
    core.debug(`Using proxy server for blob storage upload, host: ${host}`)
    let port = protocol === 'https:' ? 443 : 80
    if (portString !== '') {
      port = parseInt(portString)
    }
    options.proxyOptions = {
      host,
      port,
      username,
      password
    }
  }
  return options
 }
@@ -358,129 +358,3 @@ const {
  version, // 10.0.22621
 } = await platform.getDetails()
 ```
 #### Populating job summary
 These methods can be used to populate a [job summary](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary). A job summary is a buffer that can be added to throughout your job via `core.summary` methods.
 Job summaries when complete must be written to the summary buffer file via the `core.summary.write()` method.
 All methods except `addRaw()` utilize the `addRaw()` method to append to the buffer, followed by an EOL using the `addEOL()` method.
 ```typescript
 // Write raw text, optionally add an EOL after the content, defaults to false
 core.summary.addRaw('Some content here :speech_balloon:', true)
 // Output: Some content here :speech_balloon:\n
 // Add an operating system-specific end-of-line marker
 core.summary.addEOL()
 // Output (POSIX): \n
 // Output (Windows): \r\n
 // Add a codeblock with an optional language for syntax highlighting
 core.summary.addCodeBlock('console.log(\'hello world\')', 'javascript')
 // Output: <pre lang="javascript"><code>console.log('hello world')</code></pre>
 // Add a list, second parameter indicates if list is ordered, defaults to false
 core.summary.addList(['item1','item2','item3'], true)
 // Output: <ol><li>item1</li><li>item2</li><li>item3</li></ol>
 // Add a collapsible HTML details element
 core.summary.addDetails('Label', 'Some detail that will be collapsed')
 // Output: <details><summary>Label</summary>Some detail that will be collapsed</details>
 // Add an image, image options parameter is optional, you can supply one of or both width and height in pixels
 core.summary.addImage('example.png', 'alt description of img', {width: '100', height: '100'})
 // Output: <img src="example.png" alt="alt description of img" width="100" height="100">
 // Add an HTML section heading element, optionally pass a level that translates to 'hX' ie. h2. Defaults to h1
 core.summary.addHeading('My Heading', '2')
 // Output: <h2>My Heading</h2>
 // Add an HTML thematic break <hr>
 core.summary.addSeparator()
 // Output: <hr>
 // Add an HTML line break <br>
 core.summary.addBreak()
 // Output: <br>
 // Add an HTML blockquote with an optional citation
 core.summary.addQuote('To be or not to be', 'Shakespeare')
 // Output: <blockquote cite="Shakespeare">To be or not to be</blockquote>
 // Add an HTML anchor tag
 core.summary.addLink('click here', 'https://github.com')
 // Output: <a href="https://github.com">click here</a>
 ```
 Tables are added using the `addTable()` method, and an array of `SummaryTableRow`.
 ```typescript
 export type SummaryTableRow = (SummaryTableCell | string)[]
 export interface SummaryTableCell {
  /**
   * Cell content
   */
  data: string
  /**
   * Render cell as header
   * (optional) default: false
   */
  header?: boolean
  /**
   * Number of columns the cell extends
   * (optional) default: '1'
   */
  colspan?: string
  /**
   * Number of rows the cell extends
   * (optional) default: '1'
   */
  rowspan?: string
 }
 ```
 For example
 ```typescript
 const tableData = [
  {data: 'Header1', header: true},
  {data: 'Header2', header: true},
  {data: 'Header3', header: true},
  {data: 'MyData1'},
  {data: 'MyData2'},
  {data: 'MyData3'}
 ]
 // Add an HTML table
 core.summary.addTable([tableData])
 // Output: <table><tr><th>Header1</th><th>Header2</th><th>Header3</th></tr><tr></tr><td>MyData1</td><td>MyData2</td><td>MyData3</td></tr></table>
 ```
 In addition to job summary content, there are utility functions for interfacing with the buffer.
 ```typescript
 // Empties the summary buffer AND wipes the summary file on disk
 core.summary.clear()
 // Returns the current summary buffer as a string
 core.summary.stringify()
 // If the summary buffer is empty
 core.summary.isEmptyBuffer()
 // Resets the summary buffer without writing to the summary file on disk
 core.summary.emptyBuffer()
 // Writes text in the buffer to the summary buffer file and empties the buffer, optionally overwriting all existing content in the summary file with buffer contents. Defaults to false.
 core.summary.write({overwrite: true})
 ```