Skip to content

RELEASING.md

Latest commit

 

History

History
33 lines (23 loc) · 1.31 KB

RELEASING.md

File metadata and controls

33 lines (23 loc) · 1.31 KB

Releasing abxy/foil-server

This repository uses a manual release.yml workflow. Versions are independent from the other Foil server SDKs.

Before the first real release

Configure these GitHub and registry settings:

  1. Create a protected GitHub environment named release with required reviewer approval.
  2. Create the public package on Packagist and connect it to abxy-labs/foil-server-php.
  3. Confirm Packagist is configured to sync new GitHub tags from this repository.

Release flow

  1. Bump composer.json to the target version in a pull request.
  2. Merge the version bump to main.
  3. Open GitHub Actions and run Release.
  4. Set confirm_version to the exact composer.json version.
  5. Run a dry_run=true release first.
  6. Re-run with dry_run=false once the dry run looks correct and the release environment approval is in place.

What the workflow does

  • reads the release version from composer.json
  • reruns the equivalent of the repo checks
  • validates the Composer package metadata
  • builds a source tarball for the GitHub release
  • on real releases:
    • creates tag vX.Y.Z
    • creates a GitHub Release with the source tarball attached

Packagist should index the package from the public GitHub tag. GitHub Release notes use autogenerated notes. There is no prerelease channel in this phase.