jacobinwwey_obsidian-NotEMD/docs/maintainer/release-workflow.md

1.2 KiB

Notemd Release Workflow (Maintainers)

This document is for maintainers and contributors, not end users.

1. Regression Baseline

Capture a before-change baseline:

npm run regression:language-baseline

After implementation, compare with the latest baseline:

npm run regression:language-compare

2. Verification Gate Before Release

Run:

npm run build
npm test -- --runInBand
obsidian help
obsidian-cli help
git diff --check

If obsidian-cli is unavailable in the local environment, record it in release notes/handoff evidence.

3. Version Synchronization

Before publishing, ensure version references are aligned:

  • package.json
  • manifest.json
  • versions.json
  • README.md
  • README_zh.md
  • change.md

4. GitHub Release Requirements

Release description must be fully bilingual:

  • One complete English section.
  • One complete Chinese section.
  • Each section must be independently readable.

Required release assets:

  • main.js
  • manifest.json
  • styles.css
  • README.md

5. Suggested Release Command Pattern

gh release create <tag> main.js manifest.json styles.css README.md \
  --title "Notemd <tag>" \
  --notes-file docs/releases/<tag>.md