https://github.com/raboro/obsidian-auto-release

Scrips to automaticlly release a obsidian plugin with make release.
https://github.com/raboro/obsidian-auto-release

automation ci eslint lint shell

Last synced: 3 months ago
JSON representation

Scrips to automaticlly release a obsidian plugin with make release.

• Host: GitHub
• URL: https://github.com/raboro/obsidian-auto-release
• Owner: Raboro
• License: mit
• Created: 2023-08-29T21:00:05.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-09T19:22:05.000Z (almost 2 years ago)
• Last Synced: 2025-02-02T17:54:39.190Z (4 months ago)
• Topics: automation, ci, eslint, lint, shell
• Language: Shell
• Homepage:
• Size: 8.79 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Obsidian-Auto-Release

This repository is to automatically release a new obsidian plugin or a new version of it, just by typing the following in your terminal:

````

$ make release

````

## Usage

To use this, you need to copy the ``release.yml`` into your actions folder: ``.github/workflows``. Also copy the scripts, makefile, eslint config files and ``version-bump.mjs`` into your project. Also the scripts inside this ``package.json`` are required. You can include release notes in the ``release-notes.md`` file with markdown styles. If this file is not included no release notes are added.

## Features

- Automatically fetched the last release tag, increases it.

- Updates the version in ``package.json``, ``manifest.json`` and ``version.json``.  

- Checks if ``package.json`` and ``manifest.json`` have the same name and description and those are not empty. Also the description need to end with ``'.'`` and does not contain the words ``obsidian`` and ``plugin``.

- Use linter to fix style issues and commit those.

- Create new tag and push changes to new version and style issue fixes with tag