Merge pull request #823 from pjkaufman/master

Add Release Workflow, Update Docs, and Update Version for Release
platers · Jul 29, 2023 · 3acbe45 · 3acbe45
2 parents 15055a9 + 1ddfd34
commit 3acbe45
Show file tree

Hide file tree

Showing 9 changed files with 78 additions and 11 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,34 @@
+name: Release Obsidian plugin
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16.x"
+
+      - name: Build plugin
+        run: |
+          npm ci
+          npm run build
+
+      - name: Create release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          tag="${GITHUB_REF#refs/tags/}"
+
+          gh release create "$tag" \
+            --title="$tag" \
+            --draft \
+            main.js manifest.json src/styles.css
diff --git a/docs/docs/settings/content-rules.md b/docs/docs/settings/content-rules.md
@@ -457,7 +457,7 @@ After:
 
 Alias: `ordered-list-style`
 
-Makes sure that ordered lists follow the style specified. Note that 2 spaces or 1 tab is considered to be an indentation level.
+Makes sure that ordered lists follow the style specified. **Note: that 2 spaces or 1 tab is considered to be an indentation level.**
 
 ### Options
 

diff --git a/docs/docs/settings/footnote-rules.md b/docs/docs/settings/footnote-rules.md
@@ -93,7 +93,7 @@ Maecenas malesuada dignissim purus ac volutpat.
 
 Alias: `re-index-footnotes`
 
-Re-indexes footnote keys and footnote, based on the order of occurrence (NOTE: This rule does *not* work if there is more than one footnote for a key.)
+Re-indexes footnote keys and footnote, based on the order of occurrence. **Note: This rule does _not_ work if there is more than one footnote for a key.**
 
 
 

diff --git a/docs/docs/settings/paste-rules.md b/docs/docs/settings/paste-rules.md
@@ -148,6 +148,22 @@ Checklist item 1
 - [ ] Checklist item 2
 ``````
 </details>
+<details><summary>When pasting a checklist and the selected text starts with a checklist, the text to paste should still start with a checklist</summary>
+
+Before:
+
+`````` markdown
+- [x] Checklist item 1
+- [ ] Checklist item 2
+``````
+
+After:
+
+`````` markdown
+- [x] Checklist item 1
+- [ ] Checklist item 2
+``````
+</details>
 
 ## Prevent Double List Item Indicator on Paste
 
@@ -223,6 +239,22 @@ List item 1
 - List item 2
 ``````
 </details>
+<details><summary>When pasting a list item and the selected text starts with a list item indicator, the text to paste should still start with a list item indicator</summary>
+
+Before:
+
+`````` markdown
+- List item 1
+- List item 2
+``````
+
+After:
+
+`````` markdown
+- List item 1
+- List item 2
+``````
+</details>
 
 ## Proper Ellipsis on Paste
 
@@ -349,15 +381,15 @@ Before:
 `````` markdown
 He was sure that he would get off without doing any time, but the cops had other plans.50
 
-_Note that the format for footnote references to move is a dot or comma followed by any number of digits_
+_Note that the format for footnote references to remove is a dot or comma followed by any number of digits_
 ``````
 
 After:
 
 `````` markdown
 He was sure that he would get off without doing any time, but the cops had other plans
 
-_Note that the format for footnote references to move is a dot or comma followed by any number of digits_
+_Note that the format for footnote references to remove is a dot or comma followed by any number of digits_
 ``````
 </details>
 

diff --git a/docs/docs/settings/spacing-rules.md b/docs/docs/settings/spacing-rules.md
@@ -152,7 +152,7 @@ After:
 
 Alias: `empty-line-around-blockquotes`
 
-Ensures that there is an empty line around blockquotes unless they start or end a document. **Note that an empty line is either one less level of nesting for blockquotes or a newline character.**
+Ensures that there is an empty line around blockquotes unless they start or end a document. **Note: an empty line is either one less level of nesting for blockquotes or a newline character.**
 
 
 
@@ -1176,7 +1176,7 @@ After:
 
 Alias: `remove-space-around-characters`
 
-Ensures that certain characters are not surrounded by whitespace (either single spaces or a tab). Note that this may causes issues with markdown format in some cases.
+Ensures that certain characters are not surrounded by whitespace (either single spaces or a tab). **Note: this may causes issues with markdown format in some cases.**
 
 ### Options
 
@@ -1278,7 +1278,7 @@ After:
 
 Alias: `remove-space-before-or-after-characters`
 
-Removes space before the specified characters and after the specified characters. Note that this may causes issues with markdown format in some cases.
+Removes space before the specified characters and after the specified characters. **Note: this may causes issues with markdown format in some cases.**
 
 ### Options
 

diff --git a/docs/docs/settings/yaml-rules.md b/docs/docs/settings/yaml-rules.md
@@ -292,7 +292,7 @@ tags:
 
 Alias: `format-yaml-array`
 
-Allows for the formatting of regular YAML arrays as either multi-line or single-line and `tags` and `aliases` are allowed to have some Obsidian specific YAML formats. Note that single string to single-line goes from a single string entry to a single-line array if more than 1 entry is present. The same is true for single string to multi-line except it becomes a multi-line array.
+Allows for the formatting of regular YAML arrays as either multi-line or single-line and `tags` and `aliases` are allowed to have some Obsidian specific YAML formats. **Note: that single string to single-line goes from a single string entry to a single-line array if more than 1 entry is present. The same is true for single string to multi-line except it becomes a multi-line array.**
 
 ### Options
 
@@ -615,7 +615,7 @@ Text
 
 Alias: `yaml-key-sort`
 
-Sorts the YAML keys based on the order and priority specified. Note: may remove blank lines as well.
+Sorts the YAML keys based on the order and priority specified. **Note: may remove blank lines as well.**
 
 ### Options
 

diff --git a/manifest.json b/manifest.json
@@ -1,7 +1,7 @@
 {
   "id": "obsidian-linter",
   "name": "Linter",
-  "version": "1.17.0",
+  "version": "1.18.0",
   "minAppVersion": "0.15.6",
   "description": "Formats and styles your notes. It can be used to format YAML tags, aliases, arrays, and metadata; footnotes; headings; spacing; math blocks; regular markdown contents like list, italics, and bold styles; and more with the use of custom rule options as well.",
   "author": "Victor Tao",

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "obsidian-linter",
-  "version": "1.17.0",
+  "version": "1.18.0",
   "description": "Enforces consistent markdown styling for Obsidian (https://obsidian.md). It can be used to format YAML tags, aliases, arrays, and metadata; footnotes; headings; spacing; math blocks; regular markdown contents like list, italics, and bold styles; and more with the use of custom rule options as well.",
   "main": "main.js",
   "scripts": {

diff --git a/versions.json b/versions.json
@@ -1,4 +1,5 @@
 {
+  "1.18.0": "0.15.6",
   "1.17.0": "0.15.6",
   "1.16.0": "0.15.6",
   "1.15.2": "0.15.6",
Original file line number	Diff line number	Diff line change
Expand Up		@@ -93,7 +93,7 @@ Maecenas malesuada dignissim purus ac volutpat.

		Alias: `re-index-footnotes`

		Re-indexes footnote keys and footnote, based on the order of occurrence (NOTE: This rule does not work if there is more than one footnote for a key.)
		Re-indexes footnote keys and footnote, based on the order of occurrence. Note: This rule does _not_ work if there is more than one footnote for a key.



Expand Down