Skip to content

Commit

Permalink
chore: add generated release notes (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
dsherret authored Jan 14, 2024
1 parent f8a418c commit fd78422
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 27 deletions.
34 changes: 8 additions & 26 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -82,45 +82,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/json\/0.0.0/json\/${{ steps.get_tag_version.outputs.TAG_VERSION }}/' deployment/schema.json
# rename the wasm file
(cd target/wasm32-unknown-unknown/release/ && mv dprint_plugin_json.wasm plugin.wasm)
# create release notes
deno run -A ./scripts/generate_release_notes.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 `"json"` configuration property if desired.
```jsonc
{
// ...etc...
"json": {
// json config goes here
},
"plugins": [
"https://plugins.dprint.dev/json-${{ 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/json)
body_path: ${{ github.workspace }}-CHANGELOG.txt
draft: false
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.vscode
target
**/*.rs.bk
deployment/npm/plugin.wasm
deployment/npm/node_modules
deployment/npm/node_modules
37 changes: 37 additions & 0 deletions scripts/generate_release_notes.ts
Original file line number Diff line number Diff line change
@@ -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 = `## Changes
${changelog}
## 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 (can be done via \`dprint config add json\`).
2. Add a \`"json"\` configuration property if desired.
\`\`\`jsonc
{
// ...etc...
"json": {
// json config goes here
},
"plugins": [
"https://plugins.dprint.dev/json-${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/json)
`;

console.log(text);

0 comments on commit fd78422

Please sign in to comment.