From 9a7f685aa343ac222ccdd23c7c1401502119cee6 Mon Sep 17 00:00:00 2001 From: Aileen Booker Date: Mon, 15 Jun 2026 20:10:51 +0700 Subject: [PATCH] Added theme CI gate and agent docs Added a stable `All tests pass` gate for the repository test workflow and introduced concise `AGENTS.md` guidance with a `CLAUDE.md` symlink so agents can run the right commands and avoid committing generated or local-only files. --- .github/workflows/test.yml | 36 ++++++++++++++++++++++++++++++++++++ AGENTS.md | 25 +++++++++++++++++++++++++ CLAUDE.md | 1 + 3 files changed, 62 insertions(+) create mode 100644 .github/workflows/test.yml create mode 100644 AGENTS.md create mode 120000 CLAUDE.md diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 00000000..4151106f --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,36 @@ +name: Test + +on: + pull_request: + +permissions: + contents: read + +jobs: + test: + name: Test + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd + with: + persist-credentials: false + + - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e + with: + node-version: lts/* + cache: yarn + + - run: yarn install --frozen-lockfile + + - run: yarn test:ci + + all-tests-pass: + name: All tests pass + if: always() + needs: [test] + runs-on: ubuntu-latest + steps: + - name: Verify all required jobs succeeded + if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') + run: exit 1 diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..371e882f --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,25 @@ +# AGENTS.md + +## Scope + +This repository is the default Ghost theme. Keep changes focused on theme source, generated assets, CI, and repo-level metadata for this repository. + +## Commands + +Use Yarn Classic for this repo. + +```bash +yarn install --frozen-lockfile +yarn dev +yarn test:ci +yarn zip +``` + +Run the test command before opening a PR when theme files, generated assets, dependencies, or CI change. + +## Boundaries + +- Edit source CSS, JavaScript, Handlebars templates, partials, and package metadata intentionally. +- Keep generated assets/built/ files in sync when source assets change and the repo tracks those outputs. +- Do not commit node_modules/, local Ghost content, generated zip files outside tracked release expectations, or secrets. +- Repo settings, descriptions, and branch rules belong on the GitHub repository; internal clean-repos metadata stays in TryGhost/cleanrepos. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 120000 index 00000000..47dc3e3d --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file