kristianwindandClaude Opus 5
eca2851d35
Three things this repository could not do: prove the plugin still works on a
WordPress or WooCommerce released after it, get a fix onto a shop without
someone uploading a zip, and do either of those for the next plugin without
starting over.
ci/ is the test harness. ci/site-test.sh builds a throwaway WordPress +
WooCommerce in containers at any versions you name — including `nightly` and
`beta` — installs exactly the files the release zip will contain, and runs
tests/smoke.php inside it with wp eval-file. Real cart, real coupons, real
WC_Shipping_Rate objects: a mocked cart keeps passing after WooCommerce has
changed underneath it, which is the one failure worth catching here. WP_DEBUG
is on and any notice logged from this plugin's directory fails the build,
because that is the shape an upgrade actually breaks in — nothing fails, a
notice appears, and two releases later it is a fatal.
compat.yml runs that weekly against today's releases, the next WordPress and
the next WooCommerce, the oldest PHP the header promises and the newest PHP.
When it is green it opens a PR bumping "Tested up to" and "WC tested up to" —
only when green, because WooCommerce shows that second value to the shop owner
as an untested-plugin banner, and that banner is what they read before deciding
whether to press update.
includes/class-updater.php is the distribution half. It hooks
update_plugins_{hostname} for the host in the new "Update URI" header and reads
the Gitea release API, so WordPress handles the notice, the download, the
"Enable auto-updates" link and wp plugin update with no further code. Update
URI earns its place twice: since 5.8 a plugin that declares one is never asked
about on wordpress.org, so a .org plugin sharing this slug cannot be pushed
onto a shop running this one. The check sends nothing about the site and
overrides WordPress's default user agent, which carries the site's own URL.
release.yml tags, tests, builds, publishes — then reads the feed back with no
credentials. A private repository and a release with no zip attached both leave
a page that looks perfect to anyone logged in and an update no shop is ever
offered.
Measured before committing, all green: WP 7.1 + WC 11.1 on PHP 8.3 and 7.4,
WP 7.2-alpha on 8.3, and the beta cell falling back to stable on 8.4. No
deprecations from this plugin on any of them.
Three guards are there because the bug they catch is invisible without them:
the annotated tag is re-fetched before its message is read (checkout turns it
into a lightweight tag pointing at the merge commit), the two workflow roots
are kept in sync (.gitea/workflows hides .github/workflows entirely), and every
file the code loads must be in the release zip — which caught class-updater.php
being referenced and uncommitted while every local test passed.
docs/REUSE.md is the port to the next plugin: copy ci/, rewrite five lines.
Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
90 lines
3.4 KiB
YAML
90 lines
3.4 KiB
YAML
name: Compatibility
|
|
|
|
# The question this answers: *will the shop still work after I press update?*
|
|
#
|
|
# It runs on a schedule rather than on a commit, because the thing that breaks
|
|
# a finished plugin is not a new commit — it is a new WordPress or a new
|
|
# WooCommerce, released on somebody else's timetable. A weekly run turns that
|
|
# into a red build here, days before it turns into a broken checkout there.
|
|
#
|
|
# `nightly` and `beta` are the early warning: they are what the next release
|
|
# will be. When one of those two cells goes red and the others stay green, the
|
|
# plugin has a few weeks to be fixed rather than a few hours.
|
|
|
|
on:
|
|
schedule:
|
|
# Monday morning, so a failure has a whole week in front of it.
|
|
- cron: '0 6 * * 1'
|
|
workflow_dispatch:
|
|
# Also whenever the tooling itself changes, because a compatibility run that
|
|
# silently stopped testing anything is worse than no run at all.
|
|
pull_request:
|
|
paths:
|
|
- 'ci/**'
|
|
- 'tests/**'
|
|
- '.github/workflows/compat.yml'
|
|
- '.gitea/workflows/compat.yml'
|
|
|
|
permissions:
|
|
contents: write
|
|
pull-requests: write
|
|
|
|
# No `concurrency:` block — see the note in ci.yml. Kept byte-identical in
|
|
# .github/workflows and .gitea/workflows; ci/workflows-in-sync.sh enforces it.
|
|
|
|
jobs:
|
|
matrix:
|
|
name: WP ${{ matrix.wp }} / WC ${{ matrix.wc }} / PHP ${{ matrix.php }}
|
|
# The schedule fires on both forges, and the second run would be the same
|
|
# work again on a single self-hosted runner for no extra information.
|
|
# GitHub's runners take the scheduled load; Gitea keeps workflow_dispatch,
|
|
# so the run is still one click away there.
|
|
if: github.event_name != 'schedule' || github.server_url == 'https://github.com'
|
|
runs-on: ubuntu-latest
|
|
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
include:
|
|
# Today's shop.
|
|
- { wp: latest, wc: latest, php: '8.3' }
|
|
# The next WordPress, before it ships.
|
|
- { wp: nightly, wc: latest, php: '8.3' }
|
|
# The next WooCommerce, before it ships. Falls back to the stable
|
|
# release when there is no open beta, so the cell is never skipped.
|
|
- { wp: latest, wc: beta, php: '8.3' }
|
|
# The floor the plugin header promises. A shop on an old host is
|
|
# exactly the shop that will not notice a fatal quickly.
|
|
- { wp: latest, wc: latest, php: '7.4' }
|
|
# And the newest PHP, which is where deprecations show up first.
|
|
- { wp: latest, wc: latest, php: '8.4' }
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: Install into a throwaway shop and run the tests
|
|
env:
|
|
WP_VERSION: ${{ matrix.wp }}
|
|
WC_VERSION: ${{ matrix.wc }}
|
|
PHP_VERSION: ${{ matrix.php }}
|
|
run: ci/site-test.sh
|
|
|
|
headers:
|
|
name: Keep the compatibility headers honest
|
|
# Only after the current releases have actually been tested. Bumping
|
|
# "Tested up to" on a red build would be writing a claim we have just
|
|
# watched fail.
|
|
needs: matrix
|
|
# The PR is opened through the GitHub API, and the scheduled run that
|
|
# produces it is the GitHub one.
|
|
if: github.server_url == 'https://github.com' && github.event_name == 'schedule'
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: Bump the headers and open a PR if they are behind
|
|
env:
|
|
GH_TOKEN: ${{ github.token }}
|
|
run: ci/bump-tested-up-to.sh
|