mirror of
https://github.com/netbirdio/docs.git
synced 2026-09-26 16:59:04 +02:00
GitHub Actions runners no longer ship Node 20 for JavaScript actions, and the ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION opt-out is gone, so any action whose own action.yml declares `runs.using: node20` (or older) now fails to start. Each target tag below was verified by reading its action.yml runtime directly, not inferred from the version number. actions/checkout v3, v4, v6 -> v7 actions/setup-node v4 -> v7 actions/cache v4 -> v6 actions/setup-go v5, v6 -> v7 docker/metadata-action v5 -> v6 docker/login-action v3 -> v4 docker/build-push-action v6 -> v7 booxmedialtd/ws-action-parse-semver is knowingly left alone. It declares node12 at v1, its newest tag v1.4.7 and master are node16, and the repo has not been touched since 2023, so there is no version to move to. Replacing it is a real change, not a version bump: it validates through node-semver and fails the job on a non-semver tag, and the obvious substitutes are weaker. A plain shell capture accepts the dispatch input's own placeholder default of refs/tags/vX.Y.Z, and netbirdio/shared-actions/actions/parse-semver falls back to 0.0.0 rather than failing. Either would let the job run on past the bad version, 404 the openapi.yml download, and push a commit deleting all 36 generated API pages, because the curl has no --fail and the Go expander ignores read and parse errors. That swap needs those guards and its own PR. Breaking changes across every major crossed were checked against the actual workflow lines and none apply: setup-node v5/v6 auto-caching needs a packageManager field package.json does not have (and every call site already passes cache: 'npm'); setup-node v7 drops a NODE_AUTH_TOKEN export nothing here uses, as no step sets registry-url; cache v5/v6 and checkout v5 raise the runner floor, and every job runs on ubuntu-latest or macos-latest; checkout v6 relocates persisted credentials, which generate_api_pages already proves harmless by pushing over HTTPS on v6 today; checkout v7 blocks fork PR heads under pull_request_target and workflow_run, neither of which is a trigger in this repo; metadata-action v6 changes '#' handling in list inputs, and the one input is a bare image name; build-push-action v7 removes DOCKER_BUILD_NO_SUMMARY and DOCKER_BUILD_EXPORT_RETENTION_DAYS, neither set anywhere; setup-go v6 reworks toolchain selection, and the only Go dependency here declares go 1.18 against an installed 1.21. The two pull_request-triggered checkouts that run PR-authored code and never touch a remote — pr-build and codespell — also stop persisting a token into the workspace. build_n_push keeps its credentials: the same checkout feeds the promote step's `git ls-remote origin`, so hardening it needs a job split. setup-node's node-version stays at 20. That is a real concern separately, since Node 20 is EOL, but docker/Dockerfile is FROM node:20-slim and build_n_push builds the Next standalone bundle on the runner and copies it into that image, so build-time and runtime Node have to move together and be proven by a real build. It belongs in its own PR.
118 lines
3.9 KiB
YAML
118 lines
3.9 KiB
YAML
name: docs site build and push
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
# Build-only (no push) on PRs that touch the build/deploy pipeline, so
|
|
# Dockerfile / workflow changes are validated before they reach main.
|
|
pull_request:
|
|
paths:
|
|
- 'docker/**'
|
|
- '.dockerignore'
|
|
- '.github/workflows/build_n_push.yml'
|
|
- 'next.config.mjs'
|
|
- 'package.json'
|
|
- 'package-lock.json'
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
# Serialise non-PR runs while allowing superseded PR validation to be canceled.
|
|
# Builds publish only an immutable SHA tag; the mutable ref tag is promoted
|
|
# separately after the build and a final ref check.
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
|
|
|
|
jobs:
|
|
docs_build_n_push:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
with:
|
|
# Full history so gen:last-updated / gen:sitemap can read real
|
|
# per-file commit dates (a shallow clone would yield wrong dates).
|
|
fetch-depth: 0
|
|
|
|
- uses: actions/setup-node@v7
|
|
with:
|
|
node-version: '20'
|
|
cache: 'npm'
|
|
|
|
- name: Install dependencies
|
|
run: npm ci
|
|
|
|
- name: Restore Next.js build cache
|
|
uses: actions/cache@v6
|
|
with:
|
|
path: .next/cache
|
|
key: ${{ runner.os }}-nextjs-${{ hashFiles('package-lock.json') }}-${{ hashFiles('src/**', 'mdx/**', 'next.config.mjs') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-nextjs-${{ hashFiles('package-lock.json') }}-
|
|
|
|
- name: Build
|
|
run: npm run build
|
|
|
|
- name: Docker meta
|
|
id: meta
|
|
uses: docker/metadata-action@v6
|
|
with:
|
|
images: netbirdio/docs.netbird.io
|
|
|
|
- name: Login to DockerHub
|
|
if: github.event_name != 'pull_request'
|
|
uses: docker/login-action@v4
|
|
with:
|
|
username: ${{ secrets.DOCKER_USER }}
|
|
password: ${{ secrets.DOCKER_TOKEN }}
|
|
|
|
# Non-PR runs publish an immutable image first. A canceled or stale run
|
|
# can leave this tag behind, but it cannot change :main (or another
|
|
# mutable ref tag).
|
|
- name: Docker build and publish immutable image
|
|
uses: docker/build-push-action@v7
|
|
with:
|
|
context: .
|
|
file: docker/Dockerfile
|
|
push: ${{ github.event_name != 'pull_request' }}
|
|
# Keep a single-arch manifest (no attestation index) so the server's
|
|
# `docker compose pull` stays happy.
|
|
provenance: false
|
|
tags: netbirdio/docs.netbird.io:${{ github.sha }}
|
|
labels: ${{ steps.meta.outputs.labels }}
|
|
|
|
# Promotion is a single remote manifest-tag update after the expensive
|
|
# build. Combined with serialisation and the final ref comparison, an
|
|
# older run cannot replace the mutable tag after a newer run publishes.
|
|
- name: Promote current image to ref tag
|
|
if: github.event_name != 'pull_request'
|
|
env:
|
|
SOURCE_IMAGE: netbirdio/docs.netbird.io:${{ github.sha }}
|
|
TARGET_TAGS: ${{ steps.meta.outputs.tags }}
|
|
run: |
|
|
remote_sha="$(git ls-remote origin "${GITHUB_REF}" | awk 'NR == 1 { print $1 }')"
|
|
if [ -z "$remote_sha" ]; then
|
|
echo "Could not resolve ${GITHUB_REF} on origin" >&2
|
|
exit 1
|
|
fi
|
|
|
|
if [ "$GITHUB_SHA" != "$remote_sha" ]; then
|
|
echo "Skipping tag promotion: ${GITHUB_SHA} is stale; ${GITHUB_REF} is now ${remote_sha}"
|
|
exit 0
|
|
fi
|
|
|
|
if [ -z "$TARGET_TAGS" ]; then
|
|
echo "Docker metadata produced no target tags" >&2
|
|
exit 1
|
|
fi
|
|
|
|
while IFS= read -r target_tag; do
|
|
if [ -n "$target_tag" ]; then
|
|
docker buildx imagetools create \
|
|
--prefer-index=false \
|
|
--tag "$target_tag" \
|
|
"$SOURCE_IMAGE"
|
|
fi
|
|
done <<< "$TARGET_TAGS"
|