Document Obsidian-compatible release tags (1.0.1, not v1.0.1).

Restrict the release workflow to semver tags without a v prefix so manifest.json and GitHub releases stay aligned.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
Andre482 2026-06-18 22:23:30 +03:00
parent 2f379a623f
commit a3f01bb92b
2 changed files with 16 additions and 1 deletions

View file

@ -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:

View file

@ -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