wp-app-framework
    This documentation describes unreleased changes on the main branch.

    Release workflow

    .github/workflows/consumer-release.yml of the framework releases a theme, child theme or plugin from a tag: it builds the ZIP, tests it in fresh WordPress instances and attaches it to the GitHub release. Call it from a workflow of your project:

    on:
  push:
    tags: ['v*']

permissions:
  contents: write

jobs:
  release:
    uses: SaijSaij/wp-app-framework/.github/workflows/consumer-release.yml@v0.15.0
    with:
      cli: true
    InputTypeDefaultMeaning
    repositorystringthe calling repositorythe project to release
    refstringthe calling ref, i.e. the tagthe revision to build
    e2ebooleantruerun the browser tests (npm run test:e2e) against the release
    e2e-instancesnumber2number of WordPress instances and Playwright workers for the browser tests
    clibooleanfalserun the WP-CLI tests tests/cli/run against the release
    publishbooleantrueattach the ZIP to the GitHub release of the tag; the tag must equal v and the version in the header
    framework-refstringthe locked versionbuild with another revision of the framework
    wp-test-env-refstringmainthe revision of wp-test-env that provides the tools and the WordPress instances
    with-themestring–required for plugins and child themes: the theme release as <owner>/<repository>@<tag>

    See Releases and CI for what the workflow does step by step and what your tests receive.