diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml new file mode 100644 index 0000000..5f7a548 --- /dev/null +++ b/.github/workflows/pages.yml @@ -0,0 +1,43 @@ +name: pages + +# Publishes explainer.html as the repo's GitHub Pages site +# (https://pacphi.github.io/agentic-kit/). The file on main is the single +# source of truth — this workflow just renames it to index.html at deploy +# time, so nothing is committed twice and no gh-pages branch exists. + +on: + push: + branches: [main] + paths: + - 'explainer.html' + - '.github/workflows/pages.yml' + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +# One deploy at a time; let an in-flight deploy finish rather than cancel. +concurrency: + group: pages + cancel-in-progress: false + +jobs: + deploy: + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - uses: actions/checkout@v7 + - name: Stage site (explainer.html -> index.html) + run: | + mkdir -p _site + cp explainer.html _site/index.html + - uses: actions/configure-pages@v6 + - uses: actions/upload-pages-artifact@v5 + with: + path: _site + - id: deployment + uses: actions/deploy-pages@v5 diff --git a/MAINTAINER.md b/MAINTAINER.md index 6cbfe44..6ec02b6 100644 --- a/MAINTAINER.md +++ b/MAINTAINER.md @@ -84,7 +84,7 @@ docs/ UPGRADING.md # upgrade and capability-adoption motion (shipped) archive/ # investigative history behind each guard (not shipped) .github/ - workflows/{ci,release,nightly}.yml + workflows/{ci,release,nightly,devcontainers,pages}.yml dependabot.yml ``` @@ -220,6 +220,19 @@ CI additionally runs a **CLI smoke** against a sandboxed `HOME` (see `ci.yml`): `x reference sync` (asserts managed blocks present), `uninstall --dry-run`. If you change CLI output shape, expect the smoke to catch it. +Two further workflows cover surfaces `ci.yml` doesn't: + +- **`devcontainers.yml`** builds and smoke-tests both dev container configs with + the reference `devcontainer` CLI — on PRs touching what each config depends on + (a `dorny/paths-filter` job scopes the maintainer and consumer jobs + independently) and monthly, to catch base-image or published-package drift with + no repo change. Guide: [docs/DEVCONTAINERS.md](docs/DEVCONTAINERS.md). +- **`pages.yml`** publishes `explainer.html` as the GitHub Pages site + (): on any push to `main` touching that + file, it stages it as `index.html` and deploys. Pages source is "GitHub + Actions" (`build_type: workflow`) — there is no `gh-pages` branch, and the + file on `main` is the single source of truth. + --- ## 5. Branching methodology diff --git a/README.md b/README.md index a68a4c7..875365f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![npm version](https://img.shields.io/npm/v/@pacphi/agentic-kit/next?label=npm%40next)](https://www.npmjs.com/package/@pacphi/agentic-kit) [![node](https://img.shields.io/node/v/@pacphi/agentic-kit)](https://nodejs.org) [![license: MIT](https://img.shields.io/npm/l/@pacphi/agentic-kit)](LICENSE) +[![explainer](https://img.shields.io/badge/explainer-read_the_field_manual-C9581D)](https://pacphi.github.io/agentic-kit/) **One npm package that installs, heals, and *proves* [ruflo](https://github.com/ruvnet/ruflo) (claude-flow) + [agentic-qe](https://github.com/proffesor-for-testing/agentic-qe), grounds them in *RuvNet Brain* — an offline, source-cited knowledge base over the rUv stack — and wires Claude Code + Codex (+ opencode) into one ambidextrous, self-routing setup. macOS · Linux · Windows.** @@ -83,6 +84,8 @@ ak status read-only dashboard: what's true, what's drifted [--json] [--d ak sync converge to good: upgrade + heal + verify [--dry-run] [--no-upgrade] ak dashboard open the local web dashboard (auto-opens your browser) [--port N] [--no-open] [--live-source 'surface=path'] +ak admin maintainer-only telemetry admin (localhost; GitHub/npm egress) + [--port N] [--no-open] ak about what each installed component is and why it's there ak system machine footprint: install size, runtime, storage, catalog, projects [--deep] [--json] @@ -92,7 +95,6 @@ ak host manage execution hosts, routing, and provider bindings status | pick | refresh | off ak run execute a host-neutral activity pipeline (including explicit OpenCode routes)