https://github.com/brianrodri/semantic-release-obsidian-plugin
A semantic-release plugin for automating the releases of Obsidian plugins.
https://github.com/brianrodri/semantic-release-obsidian-plugin
obsidian obsidian-md obsidian-plugin-development obsidian-plugins semantic-release semantic-release-plugin
Last synced: about 1 year ago
JSON representation
A semantic-release plugin for automating the releases of Obsidian plugins.
- Host: GitHub
- URL: https://github.com/brianrodri/semantic-release-obsidian-plugin
- Owner: brianrodri
- Created: 2024-04-09T17:02:53.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T07:51:06.000Z (about 1 year ago)
- Last Synced: 2025-04-14T06:50:15.117Z (about 1 year ago)
- Topics: obsidian, obsidian-md, obsidian-plugin-development, obsidian-plugins, semantic-release, semantic-release-plugin
- Language: JavaScript
- Homepage: https://github.com/brianrodri/semantic-release-obsidian-plugin
- Size: 597 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# semantic-release-obsidian-plugin
[](https://github.com/brianrodri/semantic-release-obsidian-plugin/actions/workflows/CI.yml) [](https://codecov.io/gh/brianrodri/semantic-release-obsidian-plugin)
A [**semantic-release**](https://github.com/semantic-release/semantic-release) plugin for automating the [releases of Obsidian plugins](https://docs.obsidian.md/Plugins/Releasing/Release+your+plugin+with+GitHub+Actions).
| Step | Description |
| ------------------ | ------------------------------------------- |
| `verifyConditions` | Verify required metadata files are present. |
| `prepare` | Update metadata files with new version. |
## Install
```bash
$ npm install brianrodri/semantic-release-obsidian-plugin --save-dev
```
## Usage
The plugin can be configured in the [`semantic-release` configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):
```json
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"brianrodri/semantic-release-obsidian-plugin"
],
"tagFormat": "${version}"
}
```
> [!IMPORTANT]
> The `tagFormat` must be set to `${version}` to ensure that releases follow Obsidian's versioning scheme.
When `semantic-release` runs, this plugin will update the following files according to Obsidian's versioning scheme:
- `package.json`
- `package-lock.json`
- `manifest.json`
- `versions.json`