This is a template repository

This is a template repository for Obsidian plugins.

Features

• Linting Setup
• Testing Setup with Jest
• Auto Version bump
• Auto Version update

Getting started

• Clone this repo.
• Make sure your NodeJS is at least v16 (node --version).
• npm i or yarn to install dependencies.
• npm run dev to start compilation in watch mode.

Need to change

package.json

• name
• description
• author
• license (optional)

manifest.json

• id
• name
• description
• author
• authorUrl
• fundingUrl
• minAppVersion (optional)
• isDesktopOnly (optional)

LICENSE (optional)

.github/workflows/cd.yml

versioning > Configure git

git config --global user.name "YOUR-USER"
git config --global user.email "YOUR-EMAIL"

bug_report.yaml

Plugin Version > Description: The Plugin where to look for the version

CONTRIBUTING.md

Need to add

New labels

• major Version when you make incompatible API changes
• minor Version when you add functionality in a backward compatible manner
• patch Version when you make backward compatible bug fixes

Usage

1. Create feature branch
2. Make changes
3. Push feature branch
4. Create pull request
5. Add desired label to pull request
6. Merge pull request
7. Publish draft release