release-process

A GitHub release workflow automates coordinating release notes, version bumps, tests, and publishing. It updates your changelog, runs build checks, commits notes, bumps the version with npm, creates the GitHub release, and verifies the final tag and artifacts.

To keep release notes in sync, update the changelog file before running the npm version bump. The workflow commits the updated notes, executes the version increment, and packages the new build artifacts together in the GitHub release to ensure consistency.

Yes, the release process runs tests and builds the project to guarantee production readiness before publishing. This validation step ensures the GitHub release contains verified artifacts, preventing broken builds from being shipped to users.

This workflow specifically applies to Obsidian Gemini plugin releases. While it uses npm for versioning and GitHub for publishing, the automated steps target the Obsidian Gemini repository structure, including its specific release notes format and build verification.

The best way to verify a GitHub release is to check that the tag, build artifacts, and documentation align with the new version. The workflow implements a verification step to confirm the published release outcome matches the bumped version and committed notes.