@npmcli/template-oss 4.20.0 → 4.21.0

package/README.md

@@ -123,3 +123,23 @@ trivial to swap out this content directory for a different one as it is only
 referenced in a single place in `lib/config.js`. However, it's not currently
 possible to change this value at runtime, but that might become possible in
 future versions of this package.
+
+### Testing
+
+The files `test/release/release-manager.js` and `test/release/release-please.js`
+use recorded `nock` fixtures to generate snapshots. To update these fixtures run:
+
+```sh
+GITHUB_TOKEN=$(gh auth token) npm run test:record --- test/release/release-{please,manager}.js
+```
+
+If you only need to update fixtures for one, it's best to only run that single
+test file.
+
+#### `test/release/release-please.js`
+
+This test file uses the repo `npm/npm-cli-release-please` to record its
+fixtures. It expects `https://github.com/npm/npm-cli-release-please` to be
+checked out in a sibling directory to this repo. It also needs the current
+branch set to `template-oss-mock-testing-branch-do-not-delete` before the tests
+are run.

package/bin/release-manager.js

@@ -1,283 +1,29 @@
 #!/usr/bin/env node
 
-const { Octokit } = require('@octokit/rest')
-const semver = require('semver')
-const mapWorkspaces = require('@npmcli/map-workspaces')
-const { join } = require('path')
+const core = require('@actions/core')
+const { parseArgs } = require('util')
+const ReleaseManager = require('../lib/release/release-manager')
 
-const log = (...logs) => console.error('LOG', ...logs)
-
-const ROOT = process.cwd()
-const pkg = require(join(ROOT, 'package.json'))
-
-const args = process.argv.slice(2).reduce((acc, a) => {
-  const [k, v] = a.replace(/^--/g, '').split('=')
-  acc[k] = v === 'true'
-  return acc
-}, {})
-
-/* eslint-disable max-len */
-const MANUAL_PUBLISH_STEPS = `
-1. Checkout the release branch and test
-
-    \`\`\`sh
-    gh pr checkout <PR-NUMBER> --force
-    npm ${args.lockfile ? 'ci' : 'update'}
-    npm test
-    gh pr checks <PR-NUMBER> -R {NWO} --watch
-    \`\`\`
-
-1. Publish workspaces
-
-    \`\`\`sh
-    npm publish -w <WS-PKG-N>
-    \`\`\`
-
-1. Publish
-
-    \`\`\`sh
-    npm publish <PUBLISH-FLAGS>
-    \`\`\`
-
-1. Merge release PR
-
-    \`\`\`sh
-    gh pr merge <PR-NUMBER> -R {NWO} --rebase
-    git checkout <BASE-BRANCH>
-    git fetch
-    git reset --hard origin/<BASE-BRANCH>
-    \`\`\`
-`
-
-const AUTO_PUBLISH_STEPS = `
-1. Approve this PR
-
-    \`\`\`sh
-    gh pr review <PR-NUMBER> -R {NWO} --approve
-    \`\`\`
-
-1. Merge release PR :rotating_light: Merging this will auto publish :rotating_light:
-
-    \`\`\`sh
-    gh pr merge <PR-NUMBER> -R {NWO} --rebase
-    \`\`\`
-`
-
-const DEFAULT_RELEASE_PROCESS = (args.publish ? AUTO_PUBLISH_STEPS : MANUAL_PUBLISH_STEPS) + `
-1. Check For Release Tags
-
-    Release Please will run on the just pushed release commit and create GitHub releases and tags for each package.
-
-    \`\`\`
-    gh run watch -R {NWO} $(gh run list -R {NWO} -w release -b <BASE-BRANCH> -L 1 --json databaseId -q ".[0].databaseId")
-    \`\`\`
-`
-/* eslint-enable max-len */
-
-const getReleaseProcess = async ({ owner, repo }) => {
-  const RELEASE_LIST_ITEM = /^\d+\.\s/gm
-
-  log(`Fetching release process from:`, owner, repo, 'wiki')
-
-  let releaseProcess = ''
-  try {
-    releaseProcess = await new Promise((resolve, reject) => {
-      require('https')
-        .get(`https://raw.githubusercontent.com/wiki/${owner}/${repo}/Release-Process.md`, resp => {
-          let d = ''
-          resp.on('data', c => (d += c))
-          resp.on('end', () => {
-            if (resp.statusCode !== 200) {
-              reject(new Error(`${resp.req.protocol + resp.req.host + resp.req.path}: ${d}`))
-            } else {
-              resolve(d)
-            }
-          })
-        })
-        .on('error', reject)
-    })
-  } catch (e) {
-    log('Release wiki not found', e.message)
-    log('Using default release process')
-    releaseProcess = DEFAULT_RELEASE_PROCESS.replace(/\{NWO\}/g, `${owner}/${repo}`).trim() + '\n'
-  }
-
-  // XXX: the release steps need to always be the last thing in the doc for this to work
-  const releaseLines = releaseProcess.split('\n')
-  const releaseStartLine = releaseLines.reduce((acc, line, index) =>
-    line.match(/^#+\s/) ? index : acc, 0)
-  const section = releaseLines.slice(releaseStartLine).join('\n')
-
-  return section.split({
-    [Symbol.split] (str) {
-      const [, ...matches] = str.split(RELEASE_LIST_ITEM)
-      log(`Found ${matches.length} release items`)
-      return matches.map((m) => `- [ ] <STEP_INDEX>. ${m}`.trim())
-    },
-  })
-}
-
-const getPrReleases = async (pr) => {
-  const RELEASE_SEPARATOR = /<details><summary>.*<\/summary>/g
-  const MONO_VERSIONS = /<details><summary>(?:(.*?):\s)?(.*?)<\/summary>/
-  const ROOT_VERSION = /\n##\s\[(.*?)\]/
-
-  const workspaces = [...await mapWorkspaces({ pkg: pkg, cwd: ROOT })].reduce((acc, [k]) => {
-    const wsComponentName = k.startsWith('@') ? k.split('/')[1] : k
-    acc[wsComponentName] = k
-    return acc
-  }, {})
-
-  const getReleaseInfo = ({ name, version: rawVersion }) => {
-    const version = semver.parse(rawVersion)
-    const prerelease = !!version.prerelease.length
-    const tag = `${name ? `${name}-` : ''}v${rawVersion}`
-    const workspace = workspaces[name]
-
-    return {
-      name,
-      tag,
-      prerelease,
-      version: rawVersion,
-      major: version.major,
-      url: `https://github.com/${pr.base.repo.full_name}/releases/tag/${tag}`,
-      flags: `${name ? `-w ${workspace}` : ''} ${prerelease ? `--tag prerelease` : ''}`.trim(),
-    }
-  }
-
-  const releases = pr.body.match(RELEASE_SEPARATOR)
-
-  if (!releases) {
-    log('Found no monorepo, checking for single root version')
-    const [, version] = pr.body.match(ROOT_VERSION) || []
-
-    if (!version) {
-      throw new Error('Could not find version with:', ROOT_VERSION)
-    }
-
-    log('Found version', version)
-    return [getReleaseInfo({ version })]
-  }
-
-  log(`Found ${releases.length} releases`)
-
-  return releases.reduce((acc, r) => {
-    const [, name, version] = r.match(MONO_VERSIONS)
-    const release = getReleaseInfo({ name, version })
-
-    if (!name) {
-      log('Found root', release)
-      acc[0] = release
-    } else {
-      log('Found workspace', release)
-      acc[1].push(release)
-    }
-
-    return acc
-  }, [null, []])
-}
-
-const appendToComment = async ({ github, commentId, title, body }) => {
-  if (!commentId) {
-    log(`No comment id, skipping append to comment`)
-    return
-  }
-
-  const { data: comment } = await github.rest.issues.getComment({
-    ...github.repo,
-    comment_id: commentId,
-  })
-
-  const hasAppended = comment.body.includes(title)
-
-  log('Found comment with id:', commentId)
-  log(hasAppended ? 'Comment has aready been appended, replacing' : 'Appending to comment')
-
-  const prefix = hasAppended
-    ? comment.body.split(title)[0]
-    : comment.body
-
-  return github.rest.issues.updateComment({
-    ...github.repo,
-    comment_id: commentId,
-    body: [prefix, title, body].join('\n\n'),
-  })
-}
-
-const main = async (env) => {
+ReleaseManager.run({
   // These env vars are set by the release.yml workflow from template-oss
-  const {
-    CI,
-    GITHUB_TOKEN,
-    GITHUB_REPOSITORY,
-    RELEASE_PR_NUMBER,
-    RELEASE_COMMENT_ID, // comment is optional for testing
-  } = env
-
-  if (!CI || !GITHUB_TOKEN || !GITHUB_REPOSITORY || !RELEASE_PR_NUMBER) {
-    throw new Error('This script is designed to run in CI. If you want to test it, set the ' +
-      `following env vars: \`CI, GITHUB_TOKEN, GITHUB_REPOSITORY, RELEASE_PR_NUMBER\``)
-  }
-
-  const [owner, repo] = GITHUB_REPOSITORY.split('/')
-  const github = new Octokit({ auth: GITHUB_TOKEN })
-  github.repo = { owner, repo }
-
-  const { data: pr } = await github.rest.pulls.get({
-    ...github.repo,
-    pull_number: RELEASE_PR_NUMBER,
+  token: process.env.GITHUB_TOKEN,
+  repo: process.env.GITHUB_REPOSITORY,
+  cwd: process.cwd(),
+  ...parseArgs({
+    options: {
+      pr: { type: 'string' },
+      backport: { type: 'string' },
+      defaultTag: { type: 'string' },
+      lockfile: { type: 'boolean' },
+      publish: { type: 'boolean' },
+    },
+  }).values,
+})
+  .then((result) => {
+    core.setOutput('result', result)
+    return null
   })
-
-  const [release, workspaces = []] = await getPrReleases(pr)
-
-  const RELEASE_OMIT_PRERELEASE = '> NOT FOR PRERELEASE'
-  const RELEASE_OMIT_WORKSPACES = 'Publish workspaces'
-  const releaseItems = (await getReleaseProcess({ owner, repo }))
-    .filter((item) => {
-      if (release.prerelease && item.includes(RELEASE_OMIT_PRERELEASE)) {
-        return false
-      }
-
-      if (!workspaces.length && item.includes(RELEASE_OMIT_WORKSPACES)) {
-        return false
-      }
-
-      return true
-    })
-    .map((item, index) => item.replace('<STEP_INDEX>', index + 1))
-
-  log(
-    `Filtered ${releaseItems.length} release process items:\n`,
-    releaseItems.map(r => r.split('\n')[0].replace('- [ ] ', '')).join(', ')
-  )
-
-  const releaseTitle = `### Release Checklist for ${release.tag}`
-  const releaseChecklist = releaseItems
-    .join('\n\n')
-    .replace(/<PR-NUMBER>/g, RELEASE_PR_NUMBER)
-    .replace(/<RELEASE-BRANCH>/g, pr.head.ref)
-    .replace(/<BASE-BRANCH>/g, pr.base.ref)
-    .replace(/<MAJOR>/g, release.major)
-    .replace(/<X\.Y\.Z>/g, release.version)
-    .replace(/<GITHUB-RELEASE-LINK>/g, release.url)
-    .replace(/<PUBLISH-FLAGS>/g, release.flags)
-    .replace(/^(\s*\S.*)(-w <WS-PKG-N>)$/gm, workspaces.map(w => `$1${w.flags}`).join('\n'))
-    .trim()
-
-  await appendToComment({
-    github,
-    commentId: RELEASE_COMMENT_ID,
-    title: releaseTitle,
-    body: releaseChecklist,
+  .catch(err => {
+    core.setFailed('Release Manager failed')
+    core.error(err)
   })
-
-  if (!RELEASE_COMMENT_ID) {
-    console.log(releaseChecklist)
-  }
-}
-
-main(process.env)
-  // This is part of the release CI and is for posting a release manager
-  // comment to the issue but we dont want it to ever fail the workflow so
-  // just log but dont set the error code
-  .catch(err => console.error(err))

package/bin/release-please.js

@@ -1,75 +1,40 @@
 #!/usr/bin/env node
 
 const core = require('@actions/core')
-const main = require('../lib/release-please/index.js')
+const { parseArgs } = require('util')
+const ReleasePlease = require('../lib/release/release-please.js')
 
-const dryRun = !process.env.CI
-const [branch, forcePullRequest] = process.argv.slice(2)
-
-const debugPr = (val) => {
-  if (dryRun) {
-    console.log('PR:', val.title.toString())
-    console.log('='.repeat(40))
-    console.log(val.body.toString())
-    console.log('='.repeat(40))
-    for (const update of val.updates.filter(u => u.updater.changelogEntry)) {
-      console.log('CHANGELOG:', update.path)
-      console.log('-'.repeat(40))
-      console.log(update.updater.changelogEntry)
-      console.log('-'.repeat(40))
-    }
-    for (const update of val.updates.filter(u => u.updater.rawContent)) {
-      console.log('package:', update.path)
-      console.log('-'.repeat(40))
-      console.log(JSON.parse(update.updater.rawContent).name)
-      console.log(JSON.parse(update.updater.rawContent).version)
-      console.log('-'.repeat(40))
-    }
-  }
-}
-
-const debugRelease = (val) => {
-  if (dryRun) {
-    console.log('ROOT RELEASE:', JSON.stringify(val, null, 2))
-  }
-}
-
-const debugReleases = (val) => {
-  if (dryRun) {
-    console.log('ALL RELEASES:', JSON.stringify(val, null, 2))
-  }
-}
-
-main({
+ReleasePlease.run({
   token: process.env.GITHUB_TOKEN,
   repo: process.env.GITHUB_REPOSITORY,
-  dryRun,
-  branch,
-  forcePullRequest: forcePullRequest ? +forcePullRequest : null,
-}).then(({ pr, release, releases }) => {
+  ...parseArgs({
+    options: {
+      branch: { type: 'string' },
+      backport: { type: 'string' },
+      defaultTag: { type: 'string' },
+    },
+  }).values,
+  // This is mostly for testing and debugging. Use environs with the format
+  // `RELEASE_PLEASE_<manfiestOverrideConfigName>`
+  // (eg`RELEASE_PLEASE_lastReleaseSha=<SHA>`) to set one-off config items for
+  // the release please run without needing to commit and push the config.
+  overrides: Object.fromEntries(Object.entries(process.env)
+    .filter(([k, v]) => k.startsWith('RELEASE_PLEASE_') && v != null)
+    .map(([k, v]) => [k.replace('RELEASE_PLEASE_', ''), v])),
+}).then(({ pr, releases }) => {
   if (pr) {
-    debugPr(pr)
     core.setOutput('pr', JSON.stringify(pr))
     core.setOutput('pr-branch', pr.headBranchName)
     core.setOutput('pr-number', pr.number)
     core.setOutput('pr-sha', pr.sha)
   }
 
-  if (release) {
-    debugRelease(release)
-    core.setOutput('release', JSON.stringify(release))
-  }
-
   if (releases) {
-    debugReleases(releases)
     core.setOutput('releases', JSON.stringify(releases))
   }
 
   return null
 }).catch(err => {
-  if (dryRun) {
-    console.error(err)
-  } else {
-    core.setFailed(`failed: ${err}`)
-  }
+  core.setFailed('Release Please failed')
+  core.error(err)
 })

package/lib/config.js

@@ -119,7 +119,6 @@ const getFullConfig = async ({
   const gitBranches = await git.getBranches(rootPkg.path, branches)
   const defaultBranch = await git.defaultBranch(rootPkg.path) ?? 'main'
   const isReleaseBranch = !!pkgConfig.backport
-  const publishTag = isReleaseBranch ? `next-${pkgConfig.backport}` : 'latest'
   const releaseBranch = isReleaseBranch
     ? pkgConfig.releaseBranch.replace(/\*/g, pkgConfig.backport)
     : defaultBranch
@@ -148,7 +147,6 @@ const getFullConfig = async ({
     branchPatterns: gitBranches.patterns,
     isReleaseBranch,
     releaseBranch,
-    publishTag,
     dependabot: parseDependabot(pkgConfig, defaultConfig, gitBranches.branches),
     // paths
     repoDir: rootPkg.path,
@@ -168,6 +166,7 @@ const getFullConfig = async ({
     deleteJsExt: esm ? 'js' : 'cjs',
     // tap
     tap18: semver.coerce(pkg.pkgJson?.devDependencies?.tap)?.major === 18,
+    tap16: semver.coerce(pkg.pkgJson?.devDependencies?.tap)?.major === 16,
     // booleans to control application of updates
     isForce,
     isDogFood,
@@ -199,12 +198,14 @@ const getFullConfig = async ({
 
   if (pkgConfig.typescript) {
     defaultsDeep(pkgConfig, { allowPaths: [], requiredPackages: { devDependencies: [] } })
-    pkgConfig.distPaths = null
+    pkgConfig.distPaths = ['dist/']
+    pkgConfig.allowDistPaths = false
     pkgConfig.allowPaths.push('/src/')
     pkgConfig.requiredPackages.devDependencies.push(
       'typescript',
       'tshy',
-      '@typescript-eslint/parser'
+      '@typescript-eslint/parser',
+      ...derived.tap16 ? ['c8', 'ts-node'] : []
     )
   }
 
@@ -254,7 +255,7 @@ const getFullConfig = async ({
         ]),
         ...isRoot && pkgConfig.lockfile ? ['!/package-lock.json'] : [],
         ...(pkgConfig.allowPaths || []).map((p) => `!${p}`),
-        ...(pkgConfig.distPaths || []).map((p) => `!/${p}`),
+        ...(pkgConfig.allowDistPaths ? pkgConfig.distPaths : []).map((p) => `!/${p}`),
         ...(pkgConfig.ignorePaths || []),
       ]),
       // these cant be sorted since they rely on order

package/lib/content/_job-release-integration-yml.hbs

@@ -1,59 +1,51 @@
-{{#if publish}}
+name: {{#if publish}}Publish{{else}}Check Publish{{/if}}
 runs-on: ubuntu-latest
 defaults:
   run:
     shell: bash
+{{#if publish}}
 permissions:
-  deployments: write
   id-token: write
+{{/if}}
 steps:
-  - name: Checkout
-    uses: actions/checkout@v3
-    with:
-      ref: $\{{ fromJSON(needs.release.outputs.release).tagName }}
-  - name: Setup Node
-    uses: actions/setup-node@v3
-    with:
-      node-version: 18.x
-  - name: Install npm@latest
-    run: |
-      npm i --prefer-online --no-fund --no-audit -g npm@latest
-      npm config set '//registry.npmjs.org/:_authToken'=\${PUBLISH_TOKEN}
+  {{#if publish}}
+  {{> stepsSetupYml jobCheckout=(obj ref="${{ fromJSON(inputs.releases)[0].tagName }}") }}
+  - name: Set npm authToken
+    run: npm config set '//registry.npmjs.org/:_authToken'=\${PUBLISH_TOKEN}
   - name: Publish
     env:
       PUBLISH_TOKEN: $\{{ secrets.PUBLISH_TOKEN }}
-    run: npm publish --provenance --tag={{ publishTag }}
-{{else}}
-runs-on: ubuntu-latest
-defaults:
-  run:
-    shell: bash
-steps:
-  {{> stepNodeYml lockfile=false }}
-  - name: View in Registry
+  {{else}}
+  {{> stepsSetupYml }}
+  - name: Check If Published
+  {{/if}}
     run: |
       EXIT_CODE=0
 
-      function is_published {
-        if npm view "$@" --loglevel=error > /dev/null; then
+      function each_release {
+        if {{#if publish}}npm publish --provenance --tag="$1"{{else}}npm view "$@" --loglevel=error > /dev/null{{/if}}; then
           echo 0
         else
           echo 1
         fi
       }
 
-      for release in $(echo '$\{{ needs.release.outputs.releases }}' | jq -r '.[] | @base64'); do
-        name=$(echo "$release" | base64 --decode | jq -r .pkgName)
-        version=$(echo "$release" | base64 --decode | jq -r .version)
-        spec="$name@$version"
-        status=$(is_published "$spec")
-        if [[ "$status" -eq 1 ]]; then
-          echo "$spec ERROR"
-          EXIT_CODE=$status
+      for release in $(echo '$\{{ inputs.releases }}' | jq -r '.[] | @base64'); do
+        {{#if publish}}
+        PUBLISH_TAG=$(echo "$release" | base64 --decode | jq -r .publishTag)
+        STATUS=$(each_release "$PUBLISH_TAG")
+        {{else}}
+        SPEC="$(echo "$release" | base64 --decode | jq -r .pkgName)@$(echo "$release" | base64 --decode | jq -r .version)"
+        STATUS=$(each_release "$SPEC")
+        {{/if}}
+        if [[ "$STATUS" -eq 1 ]]; then
+          EXIT_CODE=$STATUS
+        {{#unless publish}}
+          echo "$SPEC ERROR"
         else
-          echo "$spec OK"
+          echo "$SPEC OK"
+        {{/unless}}       
         fi
       done
 
       exit $EXIT_CODE
-{{/if}}

package/lib/content/_step-node-yml.hbs

@@ -7,54 +7,9 @@
     {{#if lockfile}}
     cache: npm
     {{/if}}
-
 {{#if updateNpm}}
-{{#if jobIsMatrix}}
-# node 10/12/14 ship with npm@6, which is known to fail when updating itself in windows
-- name: Update Windows npm
-  if: |
-    matrix.platform.os == 'windows-latest' && (
-      startsWith(steps.node.outputs.node-version, 'v10.') ||
-      startsWith(steps.node.outputs.node-version, 'v12.') ||
-      startsWith(steps.node.outputs.node-version, 'v14.')
-    )
-  run: |
-    curl -sO https://registry.npmjs.org/npm/-/npm-7.5.4.tgz
-    tar xf npm-7.5.4.tgz
-    cd package
-    node lib/npm.js install --no-fund --no-audit -g ..\npm-7.5.4.tgz
-    cd ..
-    rmdir /s /q package
-{{/if}}
-
 - name: Install Latest npm
-  shell: bash
-  env:
-    NODE_VERSION: $\{{ steps.node.outputs.node-version }}
-  run: |
-    MATCH=""
-    SPECS=("latest" "next-10" "next-9" "next-8" "next-7" "next-6")
-
-    echo "node@$NODE_VERSION"
-
-    for SPEC in ${SPECS[@]}; do
-      ENGINES=$(npm view npm@$SPEC --json | jq -r '.engines.node')
-      echo "Checking if node@$NODE_VERSION satisfies npm@$SPEC ($ENGINES)"
-
-      if npx semver -r "$ENGINES" "$NODE_VERSION" > /dev/null; then
-        MATCH=$SPEC
-        echo "Found compatible version: npm@$MATCH"
-        break
-      fi  
-    done
-
-    if [ -z $MATCH ]; then
-      echo "Could not find a compatible version of npm for node@$NODE_VERSION"
-      exit 1
-    fi
-
-    npm i --prefer-online --no-fund --no-audit -g npm@$MATCH
-
-- name: npm Version
-  run: npm -v
+  uses: ./.github/actions/install-latest-npm
+  with:
+    node: $\{{ steps.node.outputs.node-version }}
 {{/if}}

package/lib/content/_steps-setup-yml.hbs

@@ -1,6 +1,15 @@
-{{~#if jobCheck}}{{> stepChecksYml }}{{/if}}
 {{~#unless jobSkipSetup}}
 {{> stepGitYml }}
+{{~#if jobCreateCheck}}
+- name: Create Check
+  id: create-check
+  if: {{ jobCreateCheck.sha }}
+  uses: ./.github/actions/create-check
+  with:
+    name: "{{ jobName }}{{#if jobIsMatrix}} - $\{{ matrix.platform.name }} - $\{{ matrix.node-version }}{{/if}}"
+    token: $\{{ secrets.GITHUB_TOKEN }}
+    sha: {{ jobCreateCheck.sha }}
+{{/if}}
 {{> stepNodeYml }}
 {{> stepDepsYml }}
 {{/unless}}

package/lib/content/action-create-check-yml.hbs

@@ -0,0 +1,50 @@
+name: 'Create Check'
+inputs:
+  name:
+    required: true
+  token:
+    required: true
+  sha:
+    required: true
+  check-name:
+    default: ''
+outputs:
+  check-id:
+    value: $\{{ steps.create-check.outputs.check_id }}
+runs:
+  using: "composite"
+  steps:
+    - name: Get Workflow Job
+      uses: actions/github-script@v6
+      id: workflow
+      env:
+        JOB_NAME: "$\{{ inputs.name }}"
+        SHA: "$\{{ inputs.sha }}"
+      with:
+        result-encoding: string
+        script: |
+          const { repo: { owner, repo}, runId, serverUrl } = context          
+          const { JOB_NAME, SHA } = process.env
+
+          const job = await github.rest.actions.listJobsForWorkflowRun({
+            owner,
+            repo,
+            run_id: runId,
+            per_page: 100
+          }).then(r => r.data.jobs.find(j => j.name.endsWith(JOB_NAME)))
+
+          return [
+            `This check is assosciated with ${serverUrl}/${owner}/${repo}/commit/${SHA}.`,
+            'Run logs:',
+            job?.html_url || `could not be found for a job ending with: "${JOB_NAME}"`,
+          ].join(' ')
+    - name: Create Check
+      uses: LouisBrunner/checks-action@v1.6.0
+      id: create-check
+      with:
+        token: $\{{ inputs.token }}
+        sha: $\{{ inputs.sha }}
+        status: in_progress
+        name: $\{{ inputs.check-name || inputs.name }}
+        output: |
+          {"summary":"$\{{ steps.workflow.outputs.result }}"}