From 2db5e4bf0bf5d0615f14fa97dac5395f8213870b Mon Sep 17 00:00:00 2001 From: Markus Moser Date: Mon, 11 Nov 2024 15:49:40 +0100 Subject: [PATCH] cleanup for 1.0.0 --- .eslintrc.json | 14 -------------- .github/workflows/release.yml | 8 +------- README.md | 13 +++++++++++-- showcase.png => docs/showcase.png | Bin manifest.json | 2 +- versions.json | 2 +- 6 files changed, 14 insertions(+), 25 deletions(-) delete mode 100644 .eslintrc.json rename showcase.png => docs/showcase.png (100%) diff --git a/.eslintrc.json b/.eslintrc.json deleted file mode 100644 index 1ae1cfc..0000000 --- a/.eslintrc.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "env": { - "es2021": true, - "node": true - }, - "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"], - "parserOptions": { - "parser": "@typescript-eslint/parser", - "plugins": ["@typescript-eslint"], - "root": true - }, - "ignorePatterns": ["./tsconfig.json", "**/*.json5"], - "rules": {} -} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 16ae547..d72d657 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,7 +1,4 @@ # Source: https://docs.obsidian.md/Plugins/Releasing/Release+your+plugin+with+GitHub+Actions -# to trigger it use: -# git tag -a 1.0.1 -m "1.0.1" -# git push origin 1.0.1 name: Release Obsidian plugin on: push: @@ -39,7 +36,4 @@ jobs: zip -r "${PLUGIN_NAME}".zip "$PLUGIN_NAME" tag="${GITHUB_REF#refs/tags/}" - gh release create "$tag" \ - --title="$tag" \ - --draft \ - ${PLUGIN_NAME}.zip + gh release create "$tag" --generate-notes ${PLUGIN_NAME}.zip diff --git a/README.md b/README.md index 435095d..75f6b75 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ All files, links and search results tagged with #private will get a blurred out **This plugin requires the obsidian plugin [Supercharged Links](https://github.com/mdelobelle/obsidian_supercharged_links) to work** -![showcase.png](showcase.png) +![docs/showcase.png](docs/showcase.png) # Features * Supported on Obsidian Mobile @@ -22,5 +22,14 @@ The plugin is not available on the community page, as its mostly for me personal * to compile the scss you can use sass `npm install -g sass` and `sass styles.scss styles.css` 5. Enable the plugin in your Obsidian in the Settings panel "Community Plugins" +# Releasing +There is an automatic GitHub release workflow in place that gets triggered on a push of a tag. +To push a tag: + +```bash +git tag 1.0.1 +git push origin 1.0.1 +``` + # Credits -Huge thanks to [Privacy Glasses](https://github.com/jillalberts/privacy-glasses/tree/master) for the groundwork and being licensed under MIT. Use that plugin if you want a more in depth configuration. I personally didn't need or want that much customization and overhead in my plugin. Also i found the "flickering" of all files to be distracting, so i created a simpler version for myself. +Huge thanks to [Privacy Glasses](https://github.com/jillalberts/privacy-glasses/tree/master) for the groundwork and being licensed under MIT. Use that plugin if you want a more in depth configuration. I personally didn't need or want that much customization and overhead in my plugin. Also i found the "flickering" when opening any file to be too distracting, so i created a simpler version for myself. diff --git a/showcase.png b/docs/showcase.png similarity index 100% rename from showcase.png rename to docs/showcase.png diff --git a/manifest.json b/manifest.json index 0164c41..8ad808f 100644 --- a/manifest.json +++ b/manifest.json @@ -1,5 +1,5 @@ { - "id": "private-mode", + "id": "obsidian-private-mode", "name": "Private Mode", "version": "1.0.0", "minAppVersion": "1.6.0", diff --git a/versions.json b/versions.json index 26382a1..2d71339 100644 --- a/versions.json +++ b/versions.json @@ -1,3 +1,3 @@ { - "1.0.0": "0.15.0" + "1.0.0": "1.6.0" }