WordPress.org overlay

--channel=wporg adds the files a WordPress.org listing and SVN deploy need. They are not present in an unmodified checkout of this repository.

What the overlay adds

readme.txt

The overlay readme.txt is a WordPress.org listing stub: contributors linchpin_agency, requires at least 6.9, tested up to 6.9, requires PHP 8.3, stable tag 0.1.0, license GPLv2 or later. The description says to replace it.

scripts/build.sh copies readme.txt into the zip when that file exists, then strips the x-release-please-start-version and x-release-please-end marker lines.

The deploy workflow compares the release tag (with a leading v removed) to Stable tag in the built readme.txt and fails if they differ.

Listing assets

overlays/wporg/.wordpress-org/README.md says to add a banner, an icon, and at least one screenshot. The SVN deploy and asset-update workflows copy .wordpress-org to /assets.

Deploy workflow

wordpress-plugin-deploy.yml runs on release: published and on workflow_dispatch (tag required; dry-run defaults to true on manual runs).

1. 1

   Plugin Check

   Calls ./.github/workflows/plugin-check.yml, which builds with bash scripts/build.sh and runs Plugin Check against ./build/plugin-scaffold.

2. 2

   Build the distributable

   Checks out the release tag, installs PHP 8.3 and Node from .nvmrc, and runs bash scripts/build.sh with CI=true.

3. 3

   Compare versions

   Tag vX.Y.Z must match Stable tag in build/plugin-scaffold/readme.txt.

4. 4

   SVN deploy

   Uses 10up/action-wordpress-plugin-deploy with generate-zip: false, SLUG: plugin-scaffold, BUILD_DIR: build/plugin-scaffold, and ASSETS_DIR: .wordpress-org.

Asset-update workflow

wordpress-plugin-asset-update.yml runs on pushes to main that touch readme.txt, .wordpress-org/**, or the workflow file, and on workflow_dispatch. It strips the release-please version markers from readme.txt, then runs 10up/action-wordpress-plugin-asset-update with SLUG: plugin-scaffold.

Secrets the overlay names