diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 16faf7f..c26d311 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,9 +1,13 @@ name: Release +# Obsidian Community Plugins require the GitHub tag to match manifest.json +# exactly (e.g. 1.0.1 — not v1.0.1). +# Create releases with: git tag 1.0.1 && git push origin 1.0.1 + on: push: tags: - - "*" + - "[0-9]+.[0-9]+.[0-9]+" jobs: build: diff --git a/README.md b/README.md index 59b3cf9..117a394 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,17 @@ npm run dev # watch mode npm run build # production build ``` +### Releasing + +Obsidian expects the GitHub release tag to **match `manifest.json` exactly** (e.g. `1.0.1`, not `v1.0.1`). + +```bash +npm version patch # updates package.json, manifest.json, versions.json +git push origin main --tags +``` + +Pushing a semver tag (e.g. `1.0.1`) triggers the GitHub Actions release workflow. + To deploy a local build into a vault: ```bash