Skip to content

Release and Versioning

TeemoCell edited this page Jul 20, 2026 · 2 revisions

Release and Versioning

The package follows semantic versioning:

  • patch: backwards-compatible fixes and documentation corrections;
  • minor: backwards-compatible endpoints and features;
  • major: namespace, signature, return-contract or dependency changes that require migration.

Release checklist

  1. Confirm composer.json contains teemocell/steam-web-api.
  2. Review dependency constraints and supported PHP/Laravel versions.
  3. Update the README, Wiki and migration notes.
  4. Run Composer validation and security audit.
  5. Run offline tests and any appropriate live tests.
  6. Run Rector in dry-run mode.
  7. Commit the final release changes.
  8. Create and push a semantic version tag.
  9. Create GitHub release notes.
  10. Verify Packagist receives the new tag.

Example tag

git tag -a v1.0.0 -m "Release v1.0.0"
git push origin v1.0.0

Choose the actual version from the compatibility impact and existing tag history; do not reuse or move a published release tag.

Documentation versions

The Wiki represents the latest maintained documentation and is not automatically versioned with Composer releases. Put release-specific migration details in release notes and keep breaking changes clearly marked in Migration guide.

Packagist

Publish the GitHub repository URL after the package metadata is final. Configure automatic update integration when available, then verify package name, source URL, license and released versions on Packagist.

Clone this wiki locally