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: 1 day 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 (10 months ago)
• Default Branch: main
• Last Pushed: 2025-01-21T08:13:24.000Z (3 days ago)
• Last Synced: 2025-01-21T09:22:35.673Z (3 days 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: 504 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# semantic-release-obsidian-plugin

[![CI](https://github.com/brianrodri/semantic-release-obsidian-plugin/actions/workflows/CI.yml/badge.svg)](https://github.com/brianrodri/semantic-release-obsidian-plugin/actions/workflows/CI.yml) [![codecov](https://codecov.io/gh/brianrodri/semantic-release-obsidian-plugin/graph/badge.svg?token=AVS80KF9ZI)](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`