diff --git a/.github/workflows/release-checks.yml b/.github/workflows/release-checks.yml new file mode 100644 index 0000000..d904abc --- /dev/null +++ b/.github/workflows/release-checks.yml @@ -0,0 +1,16 @@ +name: Release output checks + +on: + pull_request: + push: + branches: [main] + +jobs: + check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-node@v4 + with: + node-version: '22' + - run: node --test scripts/release.test.mjs diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 78653d3..ba26b4b 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -16,6 +16,7 @@ jobs: uses: actions/checkout@v4 with: persist-credentials: false + fetch-depth: 0 - name: Set up Node.js uses: actions/setup-node@v4 @@ -29,6 +30,7 @@ jobs: run: npm run test - name: Run semantic-release + id: release env: GH_TOKEN: ${{ secrets.GH_TOKEN }} GIT_AUTHOR_EMAIL: ${{ vars.SCN_GIT_EMAIL }} @@ -38,16 +40,10 @@ jobs: REPO_OWNER: "Local-Connectivity-Lab" REPO_NAME: "ccn-coverage-docker" TARGET_ARTIFACT_NAME: "ccn-coverage-api" - run: npx semantic-release - - - name: Get version - id: get_version - run: | - VERSION=$(node -p "require('./package.json').version") - echo "VERSION=$VERSION" >> $GITHUB_OUTPUT - echo "Released version: $VERSION" + run: node scripts/release.mjs - name: Login to Docker Registry + if: steps.release.outputs.released == 'true' uses: docker/login-action@v3 with: registry: icr.infra.seattlecommunitynetwork.org @@ -55,5 +51,7 @@ jobs: password: ${{ secrets.REGISTRY_PASSWORD }} - name: Build and publish Docker image - run: | - make publish VERSION=${{ steps.get_version.outputs.VERSION }} \ No newline at end of file + if: steps.release.outputs.released == 'true' + env: + VERSION: ${{ steps.release.outputs.version }} + run: make publish VERSION="$VERSION" diff --git a/scripts/release-output.mjs b/scripts/release-output.mjs new file mode 100644 index 0000000..9fa9d5d --- /dev/null +++ b/scripts/release-output.mjs @@ -0,0 +1,24 @@ +import { appendFileSync } from 'node:fs'; + +// Use semantic-release's result rather than guessing from package.json or Git tags. +// Existing .releaserc plugins, branches, and environment are discovered normally. +export async function runRelease(release, outputFile) { + if (!outputFile) { + throw new Error('GITHUB_OUTPUT is required before starting a release'); + } + appendFileSync(outputFile, 'released=false\n'); + const result = await release(); + if (!result) { + return false; + } + + const version = result.nextRelease?.version; + if ( + typeof version !== 'string' || + !/^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/.test(version) + ) { + throw new Error('semantic-release did not return a stable Docker release version'); + } + appendFileSync(outputFile, `released=true\nversion=${version}\n`); + return true; +} diff --git a/scripts/release.mjs b/scripts/release.mjs new file mode 100644 index 0000000..bc154f6 --- /dev/null +++ b/scripts/release.mjs @@ -0,0 +1,4 @@ +import semanticRelease from 'semantic-release'; +import { runRelease } from './release-output.mjs'; + +await runRelease(() => semanticRelease(), process.env.GITHUB_OUTPUT); diff --git a/scripts/release.test.mjs b/scripts/release.test.mjs new file mode 100644 index 0000000..84cea0d --- /dev/null +++ b/scripts/release.test.mjs @@ -0,0 +1,95 @@ +import assert from 'node:assert/strict'; +import { spawnSync } from 'node:child_process'; +import { copyFileSync, mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from 'node:fs'; +import { tmpdir } from 'node:os'; +import { join } from 'node:path'; +import test from 'node:test'; +import { runRelease } from './release-output.mjs'; + +function fixture(t) { + const directory = mkdtempSync(join(tmpdir(), 'coverage-release-test-')); + t.after(() => rmSync(directory, { recursive: true, force: true })); + return { directory, output: join(directory, 'github-output') }; +} + +function outputs(path) { + return Object.fromEntries( + readFileSync(path, 'utf8').trim().split('\n').map(line => line.split('=')), + ); +} + +test('new release publishes the exact version reported by semantic-release', async t => { + const { output } = fixture(t); + let calls = 0; + const released = await runRelease(async () => { + calls++; + assert.deepEqual(outputs(output), { released: 'false' }); + return { lastRelease: { version: '1.2.2' }, nextRelease: { version: '1.2.3' } }; + }, output); + assert.equal(calls, 1); + assert.equal(released, true); + assert.deepEqual(outputs(output), { released: 'true', version: '1.2.3' }); +}); + +for (const result of [false, undefined]) { + test(`no-release result ${result} skips Docker publishing without a version`, async t => { + const { output } = fixture(t); + assert.equal(await runRelease(async () => result, output), false); + assert.deepEqual(outputs(output), { released: 'false' }); + }); +} + +test('release errors propagate and never enable Docker publishing', async t => { + const { output } = fixture(t); + await assert.rejects( + runRelease(async () => { throw new Error('release failed'); }, output), + /release failed/, + ); + assert.deepEqual(outputs(output), { released: 'false' }); +}); + +test('missing output path fails before invoking semantic-release', async () => { + let invoked = false; + await assert.rejects(runRelease(async () => { invoked = true; }), /GITHUB_OUTPUT/); + assert.equal(invoked, false); +}); + +test('invalid or unsupported versions never enable Docker publishing', async t => { + const { output } = fixture(t); + for (const version of [undefined, 'undefined', 'v1.2.3', '01.2.3', '1.2.3-beta.1', '1.2.3\nreleased=true']) { + writeFileSync(output, ''); + await assert.rejects(runRelease(async () => ({ nextRelease: { version } }), output), /stable Docker release version/); + assert.deepEqual(outputs(output), { released: 'false' }); + } +}); + +for (const scenario of ['release', 'skip', 'error']) { + test(`workflow CLI entry point handles ${scenario}`, t => { + const { directory, output } = fixture(t); + const script = join(directory, 'release.mjs'); + copyFileSync(new URL('./release.mjs', import.meta.url), script); + copyFileSync(new URL('./release-output.mjs', import.meta.url), join(directory, 'release-output.mjs')); + const packageDirectory = join(directory, 'node_modules', 'semantic-release'); + mkdirSync(packageDirectory, { recursive: true }); + writeFileSync(join(packageDirectory, 'package.json'), JSON.stringify({ + name: 'semantic-release', type: 'module', exports: './index.js', + })); + // No GitHub, registry, Git tags, or real release side effects. + writeFileSync(join(packageDirectory, 'index.js'), ` + export default async function (...args) { + if (args.length) throw new Error('release options were overridden'); + if (process.env.RELEASE_SCENARIO === 'error') throw new Error('release failed'); + return process.env.RELEASE_SCENARIO === 'skip' + ? false : { nextRelease: { version: '2.3.4' } }; + } + `); + const result = spawnSync(process.execPath, [script], { + env: { ...process.env, GITHUB_OUTPUT: output, RELEASE_SCENARIO: scenario }, + encoding: 'utf8', + }); + assert.equal(result.error, undefined); + assert.equal(result.status, scenario === 'error' ? 1 : 0, result.stderr); + assert.deepEqual(outputs(output), scenario === 'release' + ? { released: 'true', version: '2.3.4' } : { released: 'false' }); + }); +} diff --git a/src/logger.ts b/src/logger.ts index 7e7d65e..21bf9da 100644 --- a/src/logger.ts +++ b/src/logger.ts @@ -1,8 +1,7 @@ -import path from 'path'; -import pino, { multistream } from 'pino'; +import pino from 'pino'; function createLogger() { - const logLevel = process.env.LOG_LEVEL || 'debug'; + const logLevel = process.env.LOG_LEVEL || 'info'; // Configure the logger const loggerOptions: pino.LoggerOptions = { @@ -24,12 +23,8 @@ function createLogger() { }, }; - const logStreams = pino.multistream([ - { level: 'debug', stream: process.stdout }, - { level: 'warn', stream: process.stderr }, - ]); - - const logger = pino(loggerOptions, logStreams); + // Docker collects stdout. A single stream avoids duplicating warnings/errors. + const logger = pino(loggerOptions, process.stdout); // Make sure logs are flushed on exit process.on('exit', () => {