Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 1.36 KB

RELEASING.md

File metadata and controls

27 lines (20 loc) · 1.36 KB

Releasing Markfly

Naming rules

  • Keep the app version in package.json as plain semantic version: X.Y.Z (for example, 0.4.2).
  • Name every Git tag vX.Y.Z (for example, v0.4.2). The tag must match the app version exactly.
  • Name every GitHub Release Markfly vX.Y.Z (for example, Markfly v0.4.2). Do not add feature summaries to the title; put release notes in the release body.
  • Keep artifact names generated by electron-builder unchanged: Markfly-X.Y.Z-arm64.<ext>.

Release steps

  1. Update version in package.json and the matching version in package-lock.json.

  2. Run npm ci and npm run build; run npm run electron:build when validating macOS packaging locally.

  3. Commit and merge the version bump to main.

  4. From the merged commit, create and push the matching tag:

    git switch main
    git pull --ff-only
    git tag vX.Y.Z
    git push origin vX.Y.Z
  5. The Build & Release GitHub Actions workflow verifies tag/version match, builds macOS .dmg, .pkg, and .zip assets, then publishes the GitHub Release as Markfly vX.Y.Z with generated release notes.

  6. Check the workflow completed successfully. Verify release title, tag, generated notes, and all expected assets on GitHub.

Do not upload build artifacts manually unless the automated workflow is unavailable and a maintainer explicitly chooses a manual recovery.