tpl
/
obsidian-sample-plugin
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

better README instructions

This commit is contained in:
Evan Bonsignori 2023-08-27 16:21:36 -07:00
parent 31d68d0665
commit 8299f33d72
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -43,14 +43,20 @@ Quick starting guide for new plugin devs:
### Automatically ### Automatically
Using the [release](.github/release.yml) workflow, you can create and push a tag. For example, In [.github/release.yml](.github/release.yml) replace "my-plugin" with the name of your plugin on the following line,
```yml
PLUGIN_NAME: my-plugin
``` ```
After updating your plugin name, you can create and push a tag. For example,
```bash
git tag 1.2.3 git tag 1.2.3
git push origin 1.2.3 git push origin 1.2.3
``` ```
The workflow will automatically: Then [release.yml](.github/release.yml) will automatically:
1. Update `manifest.json`, `package.json`, and `package-lock.json` with the version from your tag. 1. Update `manifest.json`, `package.json`, and `package-lock.json` with the version from your tag.
2. Commit the updates to your repo (that you will need to pull down locally before making further changes) 2. Commit the updates to your repo (that you will need to pull down locally before making further changes)
3. Create a new release for your tag in your [repo's Releases](https://github.com/obsidianmd/obsidian-sample-plugin/releases). 3. Create a new release for your tag in your [repo's Releases](https://github.com/obsidianmd/obsidian-sample-plugin/releases).