CI/CD

Mon, 01 Jan 0001 00:00:00 +0000

Agent-support checks

The site has an AFDocs configuration and npm script to generate a scorecard locally:

Config: agent-docs.config.yml
Script: _check:afdocs in package.json

To generate a fresh scorecard, run each of these commands in separate terminals:

npm run serve # From one terminal
npm run check:afdocs:dev # From another terminal

The latter command saves the generated scorecard to docs/content/agent-support/afdocs-scorecard.txt under content, which will be included in Scorecard examples on the next build.

Note that the scorecard generation is not run as a part of the full CI/CD pipeline. It needs to be run manually.

Git repository layout and branch model

Mon, 01 Jan 0001 00:00:00 +0000

Repositories

Oink uses two focused repositories:

Repository	Responsibility
Oink theme	Published Hugo Module, layouts, assets, and i18n
Oink project site	Documentation, examples, regression tests, and CI

The theme repository has no embedded example site or npm workspace. Consumer sites import github.com/pgsty/oink; the project site is one such consumer.

For local development, clone both repositories as siblings and connect them with an ignored Go workspace:

~/pgsty/
├── oink/
└── oink.pgsty.com/

cd ~/pgsty/oink.pgsty.com
go work init .
go work edit -replace=github.com/pgsty/oink=../oink
export HUGO_MODULE_WORKSPACE=go.work
npm install
npm run serve

Branch model

The theme repository uses:

Build on OINK

CI/CD

Agent-support checks

Git repository layout and branch model

Repositories

Branch model