forked from Ports/goldeneye-pc-port
James Dansereau
ce9e090527
The pull_request trigger already has paths-ignore (**.md, docs/**, LICENSE, NOTICE), but push to main deliberately has none so tag builds always run and the required check never hangs pending. A docs-only merge to main therefore still ran a full ~15 min Windows build for nothing. Add a lightweight 'changes' job (pure git diff against github.event.before, no third-party action) that mirrors those globs. validate + windows-build now gate on needs.changes.outputs.code == 'true'; the job forces true for tags and for pull_request / workflow_dispatch, so only docs-only branch pushes are skipped. Skipped required checks report green to branch protection.
209 lines
7.8 KiB
YAML
209 lines
7.8 KiB
YAML
name: CI
|
|
|
|
on:
|
|
push:
|
|
branches: [ main, master ]
|
|
tags: [ 'v*' ]
|
|
# No paths-ignore here: tag pushes must always build so a release can be
|
|
# cut even when the tagged commit only touched docs, and a workflow that
|
|
# never triggers would leave a required status check pending forever.
|
|
# Docs-only branch pushes are instead skipped by the `changes` job below,
|
|
# which reports the build jobs as "skipped" (green for branch protection).
|
|
pull_request:
|
|
paths-ignore: [ '**.md', 'docs/**', 'LICENSE', 'NOTICE' ]
|
|
workflow_dispatch:
|
|
|
|
# Minimal token: CI only reads the repo and uploads build artifacts, neither of
|
|
# which needs write access. Fork PRs run untrusted build scripts on the runner,
|
|
# so keep the granted scope as small as possible and never expose secrets here.
|
|
permissions:
|
|
contents: read
|
|
|
|
concurrency:
|
|
group: ci-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
# Three jobs:
|
|
#
|
|
# validate — ubuntu, configure-only. Byte-compiles the tooling,
|
|
# regenerates the US ROM-asset symbol file, and CMake-
|
|
# configures ntsc-final (REGION_DEFS, the source list, and
|
|
# that SDL2 / zlib / OpenGL are discoverable). No ROM is used.
|
|
# Does NOT compile; running on ubuntu is NOT a claim the port
|
|
# works on Linux.
|
|
#
|
|
# windows-build — windows/MSYS2, the real supported platform. Compiles and
|
|
# links the full executable, then packages the distributable
|
|
# bundle (exe + runtime DLLs + README + licenses, NO ROM /
|
|
# assets) via tools_pc/bundle-win.sh and uploads it. Neither
|
|
# the ROM nor extracted assets are needed to BUILD (they are
|
|
# runtime-only), so CI builds but never runs the port.
|
|
#
|
|
# release — tags only (v*). Downloads the bundle from windows-build and
|
|
# attaches it to a DRAFT pre-release for that tag. Draft, so a
|
|
# human does the ROM smoke-test and hits Publish. This is the
|
|
# only job granted contents: write.
|
|
|
|
jobs:
|
|
# Did this push touch anything outside docs / licenses? Branch pushes to main
|
|
# get no workflow-level paths-ignore (see the `on:` comment), so this is where
|
|
# a docs-only merge is filtered out. Tags and pull_request events always build.
|
|
# Mirrors the pull_request paths-ignore globs: **.md, docs/**, LICENSE, NOTICE.
|
|
changes:
|
|
runs-on: ubuntu-22.04
|
|
outputs:
|
|
code: ${{ steps.filter.outputs.code }}
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
with:
|
|
persist-credentials: false
|
|
fetch-depth: 0
|
|
|
|
- id: filter
|
|
run: |
|
|
if [ "${{ github.event_name }}" != "push" ] || [ "${GITHUB_REF_TYPE}" = "tag" ]; then
|
|
echo "code=true" >> "$GITHUB_OUTPUT"; exit 0
|
|
fi
|
|
base='${{ github.event.before }}'
|
|
if ! git cat-file -e "${base}^{commit}" 2>/dev/null; then
|
|
echo "no usable base ${base} — building to be safe"
|
|
echo "code=true" >> "$GITHUB_OUTPUT"; exit 0
|
|
fi
|
|
changed="$(git diff --name-only "$base" '${{ github.sha }}')"
|
|
echo "Changed files:"; echo "$changed"
|
|
if echo "$changed" | grep -qvE '(\.md$|^docs/|^LICENSE$|^NOTICE$)'; then
|
|
echo "code=true" >> "$GITHUB_OUTPUT"
|
|
else
|
|
echo "docs-only push — skipping build"
|
|
echo "code=false" >> "$GITHUB_OUTPUT"
|
|
fi
|
|
|
|
validate:
|
|
needs: changes
|
|
if: needs.changes.outputs.code == 'true'
|
|
runs-on: ubuntu-22.04
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- name: Install dependencies
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get install -y cmake python3 libsdl2-dev zlib1g-dev libgl1-mesa-dev
|
|
|
|
- name: Byte-compile Python tooling
|
|
run: python3 -m compileall -q scripts tools_pc
|
|
|
|
# US only. gen_romassets.py resolves every symbol for the US region from
|
|
# the committed CSVs with no ROM present; PAL/JP each need a handful of
|
|
# region-specific prop/font offsets that only come from that region's ROM
|
|
# (see docs/building.md — PAL/JP builders generate romassets_e/j.s
|
|
# locally). No ROM is used or required here.
|
|
- name: Regenerate ROM-asset symbol file (US)
|
|
run: |
|
|
python3 scripts/gen_romassets.py u
|
|
git diff --stat -- port/src/romassets_u.s
|
|
|
|
- name: CMake configure (ntsc-final)
|
|
run: cmake -S . -B build-ntsc -DROMID=ntsc-final
|
|
|
|
# Real Windows (MSYS2 MINGW64) build — the only platform the port is
|
|
# developed and tested on. This compiles and LINKS the full executable.
|
|
#
|
|
# No ROM and no extracted assets are needed to build: the compiled asset set
|
|
# is a handful of committed pure-data .c files plus the generated
|
|
# address-constant romassets_<region>.s. The ROM (.z64) and the ROM-derived
|
|
# blobs are runtime-only dependencies — CI cannot run the game, only build it.
|
|
windows-build:
|
|
needs: changes
|
|
if: needs.changes.outputs.code == 'true'
|
|
runs-on: windows-latest
|
|
defaults:
|
|
run:
|
|
shell: msys2 {0}
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- uses: msys2/setup-msys2@v2
|
|
with:
|
|
msystem: MINGW64
|
|
update: true
|
|
install: >-
|
|
mingw-w64-x86_64-toolchain
|
|
mingw-w64-x86_64-cmake
|
|
mingw-w64-x86_64-SDL2
|
|
mingw-w64-x86_64-zlib
|
|
mingw-w64-x86_64-python
|
|
zip
|
|
unzip
|
|
|
|
- name: Regenerate ROM-asset symbol file (US)
|
|
run: python scripts/gen_romassets.py u
|
|
|
|
- name: Build (ntsc-final)
|
|
run: ./build-pc.sh ntsc-final
|
|
|
|
# Package the distributable bundle on every run so the release path is
|
|
# always exercised. On a tag build VERSION is the tag; otherwise it is a
|
|
# throwaway CI string. bundle-win.sh hard-fails if a ROM image or an
|
|
# oversized blob ends up inside the bundle.
|
|
- name: Package Windows bundle
|
|
run: |
|
|
if [ "${GITHUB_REF_TYPE}" = "tag" ]; then
|
|
V="${GITHUB_REF_NAME}"
|
|
else
|
|
V="0.0.0-ci.${GITHUB_SHA::7}"
|
|
fi
|
|
tools_pc/bundle-win.sh "$V"
|
|
|
|
- name: Upload bundle
|
|
uses: actions/upload-artifact@v7
|
|
with:
|
|
name: goldeneye-pc-port-win64
|
|
path: |
|
|
dist/*.zip
|
|
dist/*.zip.sha256
|
|
if-no-files-found: error
|
|
retention-days: 14
|
|
|
|
# CI builds and packages the executable but does not run it — running the
|
|
# port needs a ROM, which CI does not provide. Runtime checks (the
|
|
# -level_09 soak, a golden-frame diff) would run on a self-hosted runner
|
|
# instead. Not planned.
|
|
|
|
# Tags only. Attach the packaged bundle to a DRAFT pre-release so a human can
|
|
# do the ROM smoke-test before publishing. This job — and only this job —
|
|
# gets contents: write.
|
|
release:
|
|
if: github.ref_type == 'tag'
|
|
needs: [ changes, validate, windows-build ]
|
|
runs-on: ubuntu-22.04
|
|
permissions:
|
|
contents: write
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- uses: actions/download-artifact@v7
|
|
with:
|
|
name: goldeneye-pc-port-win64
|
|
path: dist
|
|
|
|
- name: Create or update draft pre-release
|
|
env:
|
|
GH_TOKEN: ${{ github.token }}
|
|
run: |
|
|
TAG="${GITHUB_REF_NAME}"
|
|
if gh release view "$TAG" >/dev/null 2>&1; then
|
|
gh release upload "$TAG" dist/*.zip dist/*.zip.sha256 --clobber
|
|
else
|
|
gh release create "$TAG" dist/*.zip dist/*.zip.sha256 \
|
|
--draft --prerelease \
|
|
--title "GoldenEye 007 PC Port $TAG" \
|
|
--notes-file .github/release-notes.md
|
|
fi
|