Skip to content

release-guideline.md

Latest commit

 

History

History
90 lines (64 loc) · 2.77 KB

release-guideline.md

File metadata and controls

90 lines (64 loc) · 2.77 KB
Raw

Release Guide

CI Release (Recommended)

Releases are tag-driven. Push a version tag and CI handles everything.

Steps:

  1. Create a version tag (must start with v; release from main or other branches; pick a version from: xgplayer versions and tags)
  2. Push the tag to remote
  3. Wait for CI to complete the release

Stable release:

git tag v3.2.1
git push origin v3.2.1

Prerelease:

git tag v3.2.1-rc.1
git push origin v3.2.1-rc.1

Stable vs Prerelease

  • Stable tag (e.g. v3.2.1): publishes to npm, creates a GitHub Release, and commits version changes back to main
  • Prerelease tag (e.g. v3.2.1-rc.1): publishes to npm, creates a GitHub Prerelease, and does not modify main

Release Notes

GitHub Release notes are generated by CI. Stable releases compare against the latest previous stable tag (vX.Y.Z). Prereleases compare against the nearest previous version tag, including prerelease tags when available.

Automatic Release Notes Caveat

What's Changed is generated by the release workflow through GitHub's generateReleaseNotes API, not by parsing commit logs locally. It mainly lists merged pull requests in the selected compare range. Direct commits may only appear in Full Changelog; manually add them to the release body if they need to be called out.

CI Workflow

Workflow file: .github/workflows/publish.yml

Trigger: push.tags: v*

Jobs:

  1. build
    • Extracts the tag name
    • Determines whether it is a stable release
    • Sets the version and builds artifacts
  2. release_npm
    • Downloads build artifacts
    • Publishes to npm
  3. release_github
    • Creates GitHub Release from the tag (as Prerelease for non-stable tags)
  4. commit_to_main (stable only)
    • Applies version changes
    • Commits and pushes to main
  5. release_summary
    • Reports the overall release status