Add readme and changelog to vsix (#538)

mark-wiemer · Oct 8, 2024 · 5c625b1 · 5c625b1
1 parent 7d31170
commit 5c625b1
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 6 deletions.
diff --git a/Changelog.md → changelog.md b/Changelog.md → changelog.md
diff --git a/docs/Development.md b/docs/Development.md
@@ -43,7 +43,7 @@ Unless otherwise specified, commit messages don't matter.
 1. Tag the release
     1. e.g. `git checkout main && git pull && git tag v1.2.3 && git push origin v1.2.3`
     1. [Create a new GitHub release for this tag](https://github.com/mark-wiemer-org/ahkpp/tags)
-        1. Release title: Same as in [Changelog.md](../Changelog.md)
+        1. Release title: Same as in [changelog.md](../changelog.md)
         1. Description: Changelog entry, excluding the heading for this version
         1. Attach binary
         1. Publish release

diff --git a/package.json b/package.json
@@ -42,7 +42,9 @@
         "dist/extension.js",
         "icon.png",
         "license.txt",
-        "package.nls.*"
+        "package.nls.*",
+        "changelog.md",
+        "readme.md"
     ],
     "scripts": {
         "prebuild": "npm run clean:dist",
@@ -63,7 +65,7 @@
         "format:fix": "prettier --write .",
         "lint": "npm run format && npm run eslint && npm run sort-package-json",
         "lint:fix": "npm run format:fix && npm run eslint:fix && npm run sort-package-json:fix",
-        "package": "vsce package -o ahkpp.vsix",
+        "package": "vsce package -o ahkpp.vsix --allow-unused-files-pattern",
         "prepare": "git submodule update --init --recursive && cd ahk2 && npm install",
         "sort-package-json": "sort-package-json --check",
         "sort-package-json:fix": "sort-package-json",

diff --git a/readme.md b/readme.md
@@ -26,15 +26,15 @@ AHK++ 6 now incorporates [AutoHotkey v2 Language Support by thqby](https://marke
 -   Rich IntelliSense support with snippets, hover text, and suggestions
 -   Formatting files with many customized options
 
-For all changes, including breaking changes, see [the changelog](./Changelog.md)
+For all changes, including breaking changes, see [the changelog](./changelog.md)
 
 As always, please [🐛 report any issues](https://github.com/mark-wiemer-org/ahkpp/issues/new/choose)
 
 💚 Special thanks again to [thqby](https://github.com/thqby), as this would not have been possible without thqby's open-source [AutoHotkey v2 Language Support](https://marketplace.visualstudio.com/items?itemName=thqby.vscode-autohotkey2-lsp)!
 
 ### ⛓️‍💥 Breaking changes
 
-When adding all the new settings, VS Code's setting UX became overwhelming. Settings are now organized into flat objects, which should improve UX and reduce the need for breaking changes in the future! See [the changelog](./Changelog.md) for details.
+When adding all the new settings, VS Code's setting UX became overwhelming. Settings are now organized into flat objects, which should improve UX and reduce the need for breaking changes in the future! See [the changelog](./changelog.md) for details.
 
 ---
 

diff --git a/security.md b/security.md
@@ -2,7 +2,7 @@
 
 ## Supported Versions
 
-All non-[yanked](./Changelog.md#283-yanked---2022-07-04-🦅) versions.
+All non-[yanked](./changelog.md#283-yanked---2022-07-04-🦅) versions.
 
 ## Reporting a Vulnerability