chore: add generated change log to releases (#598)

dprint · Jan 8, 2024 · 52d2c91 · 52d2c91
1 parent 5f8ecfd
commit 52d2c91
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 67 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -105,48 +105,27 @@ jobs:
       run: cargo publish
 
       # GITHUB RELEASE
+    - uses: denoland/setup-deno@v1
+      if: matrix.config.kind == 'test_release' && startsWith(github.ref, 'refs/tags/')
+      with:
+        deno-version: v1.x
     - name: Pre-release
       if: matrix.config.kind == 'test_release' && startsWith(github.ref, 'refs/tags/')
       run: |
         # update config schema to have version
         sed -i 's/typescript\/0.0.0/typescript\/${{ steps.get_tag_version.outputs.TAG_VERSION }}/' deployment/schema.json
         # rename the wasm file
         (cd target/wasm32-unknown-unknown/release/ && mv dprint_plugin_typescript.wasm plugin.wasm)
+        # create release notes
+        deno run -A ./scripts/generateReleaseNotes.ts ${{ steps.get_tag_version.outputs.TAG_VERSION }} > ${{ github.workspace }}-CHANGELOG.txt
     - name: Release
-      uses: softprops/action-gh-release@59c3b4891632ff9a897f99a91d7bc557467a3a22
+      uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844
       if: matrix.config.kind == 'test_release' && startsWith(github.ref, 'refs/tags/')
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
         files: |
           target/wasm32-unknown-unknown/release/plugin.wasm
           deployment/schema.json
-        body: |
-          ## Install
-
-          [Install](https://dprint.dev/install/) and [setup](https://dprint.dev/setup/) dprint.
-
-          Then in your project's dprint configuration file:
-
-          1. Specify the plugin url in the `"plugins"` array.
-          2. Add a `"typescript"` configuration property if desired.
-             ```jsonc
-             {
-               // ...etc...
-               "typescript": {
-                 // TypeScript & JavaScript config goes here
-               },
-               "excludes": [
-                 "**/node_modules"
-               ],
-               "plugins": [
-                 "https://plugins.dprint.dev/typescript-${{ steps.get_tag_version.outputs.TAG_VERSION }}.wasm"
-               ]
-             }
-             ```
-
-          ## JS Formatting API
-
-            * [JS Formatter](https://github.com/dprint/js-formatter) - Browser/Deno and Node
-            * [npm package](https://www.npmjs.com/package/@dprint/typescript)
+        body_path: ${{ github.workspace }}-CHANGELOG.txt
         draft: false
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@
 sourcemap
 deployment/npm/plugin.wasm
 deployment/npm/node_modules
+.vscode
diff --git a/.vscode/launch.json b/.vscode/launch.json
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
diff --git a/scripts/generateReleaseNotes.ts b/scripts/generateReleaseNotes.ts
@@ -0,0 +1,37 @@
+import { generateChangeLog } from "https://raw.githubusercontent.com/dprint/automation/0.9.0/changelog.ts";
+
+const version = Deno.args[0];
+const changelog = await generateChangeLog({
+  versionTo: version,
+});
+const text = `${changelog}\n
+## Install
+
+[Install](https://dprint.dev/install/) and [setup](https://dprint.dev/setup/) dprint.
+
+Then in your project's dprint configuration file:
+
+1. Specify the plugin url in the \`"plugins"\` array.
+2. Add a \`"typescript"\` configuration property if desired.
+   \`\`\`jsonc
+   {
+     // ...etc...
+     "typescript": {
+       // TypeScript & JavaScript config goes here
+     },
+     "excludes": [
+       "**/node_modules"
+     ],
+     "plugins": [
+       "https://plugins.dprint.dev/typescript-${version}.wasm"
+     ]
+   }
+   \`\`\`
+
+## JS Formatting API
+
+* [JS Formatter](https://github.com/dprint/js-formatter) - Browser/Deno and Node
+* [npm package](https://www.npmjs.com/package/@dprint/typescript)
+`;
+
+console.log(text);