Skip to content

Comments

chore: update docs for git tag updates#536

Merged
k11kirky merged 1 commit intomainfrom
01-18-chore_update_docs_for_git_tag_updates
Jan 19, 2026
Merged

chore: update docs for git tag updates#536
k11kirky merged 1 commit intomainfrom
01-18-chore_update_docs_for_git_tag_updates

Conversation

@k11kirky
Copy link
Contributor

@k11kirky k11kirky commented Jan 19, 2026

TL;DR

Updated version tagging format docs to use proper three-part semver versions to ensure Electron auto-updates work correctly.

What changed?

  • Changed all base tag examples from two-part format (vX.Y) to three-part format (vX.Y.0)
  • Updated all references and examples throughout the document to use the three-part semver format
  • Added an important note explaining that Electron auto-updater requires valid semver for version comparison
  • Updated the git tag search command to look for three-part version tags

How to test?

  1. Verify the updated documentation accurately reflects the new tagging format
  2. Test the updated git commands to ensure they correctly identify the latest version tag
  3. Confirm that creating a new tag with the format vX.Y.0 works as expected for version calculation

Why make this change?

The Electron auto-updater uses update.electronjs.org, which requires valid semver for version comparison. Two-part versions were breaking the auto-update functionality. This change ensures that all version tags follow proper semver format, maintaining compatibility with the Electron update system.

Copy link
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@k11kirky k11kirky marked this pull request as ready for review January 19, 2026 04:44
@k11kirky k11kirky requested a review from a team as a code owner January 19, 2026 04:44
@k11kirky k11kirky merged commit 1a849eb into main Jan 19, 2026
12 checks passed
@k11kirky k11kirky deleted the 01-18-chore_update_docs_for_git_tag_updates branch January 19, 2026 07:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants