From 16566addfbac2bf407fa3dcd8199aca23120ed89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johan=20Satg=C3=A9?= Date: Wed, 3 Jan 2024 17:21:08 +0100 Subject: [PATCH] Add publishing instructions --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 5888b6f..e55e4b9 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,9 @@ - [Installation](#installation) - [Usage](#usage) +- [Publish a new version](#publish-a-new-version) +- [Changelog](#changelog) +- [License](#license) ## Installation @@ -49,6 +52,18 @@ The following options are available: | `includeLinks` | `true` | Make headings clickable | | `debugInConsole` | `false` | Print debug info in Obsidian console | +## Publish a new version + +- Push a commit with the new version number as message with: + - The relevant changelog in `README.md` + - The new version number in `manifest.json` +- Tag the commit with the version number +- Publish a [new GitHub release](https://github.com/johansatge/obsidian-automatic-table-of-contents/releases/new) with: + - The version number as title + - The changelog from `README.md` as description + - `main.js` and `manifest.json` as attachments + - _Set as the latest release_ checked + ## Changelog This project uses [semver](http://semver.org/).