Skip to content

release.md

Latest commit

 

History

History
31 lines (24 loc) · 1.13 KB

release.md

File metadata and controls

31 lines (24 loc) · 1.13 KB

Automatic Release

Use automatic-release.yml for semantic-release based releases.

jobs:
  release:
    uses: sympress/workflows/.github/workflows/automatic-release.yml@v1
    secrets:
      GITHUB_USER_TOKEN: ${{ secrets.GITHUB_TOKEN }}

If the repository has release.config.cjs, it is used. Otherwise, the workflow copies the built-in SymPress config and helper script from the pinned workflow_ref input. The default is v1, so create the workflow tag before relying on the fallback config in production.

The fallback config:

  • supports main, next, beta, and alpha;
  • generates changelog entries;
  • creates GitHub releases;
  • updates composer.json, package.json, package-lock.json, and WordPress headers when present;
  • commits release files with [skip ci].

The fallback config enables the npm plugin only when the caller repository has package.json, so PHP-only repositories do not need a placeholder package file.

The workflow serializes releases per ref and installs pinned semantic-release packages. Production callers should pin this workflow to a release tag. See Release Strategy.