Skip to content

Commit 954222c

Browse files
abelanger5grutt
andauthored
docs: add README for VSCode extension (#3390)
* add README * ops: publish to open vsx --------- Co-authored-by: Gabe Ruttner <gabriel.ruttner@gmail.com>
1 parent b08ff55 commit 954222c

4 files changed

Lines changed: 85 additions & 0 deletions

File tree

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Open VSX Extension Release
2+
3+
on:
4+
push:
5+
tags:
6+
- "vscode/v*"
7+
8+
permissions:
9+
contents: read
10+
11+
jobs:
12+
release:
13+
name: Package and Publish to Open VSX
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout
18+
uses: actions/checkout@v4
19+
20+
- name: Setup Node.js
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: "24"
24+
25+
- name: Setup pnpm
26+
uses: pnpm/action-setup@v4
27+
with:
28+
version: 10
29+
run_install: false
30+
31+
- name: Get pnpm store directory
32+
shell: bash
33+
run: echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
34+
35+
- name: Cache pnpm store
36+
uses: actions/cache@v4
37+
with:
38+
path: ${{ env.STORE_PATH }}
39+
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('frontend/vscode-extension/pnpm-lock.yaml') }}
40+
restore-keys: |
41+
${{ runner.os }}-pnpm-store-
42+
43+
- name: Install dependencies
44+
working-directory: frontend/vscode-extension
45+
run: pnpm install --frozen-lockfile
46+
47+
- name: Build VS Code extension
48+
working-directory: frontend/vscode-extension
49+
run: pnpm build:prod
50+
51+
- name: Set publisher to hatchet-dev for Open VSX
52+
working-directory: frontend/vscode-extension
53+
run: jq '.publisher = "hatchet-dev"' package.json > tmp.json && mv tmp.json package.json
54+
55+
- name: Extract version from tag
56+
id: version
57+
run: echo "VERSION=${GITHUB_REF_NAME#vscode/v}" >> $GITHUB_OUTPUT
58+
59+
- name: Package extension
60+
working-directory: frontend/vscode-extension
61+
run: pnpm package --out hatchet-${{ steps.version.outputs.VERSION }}.vsix
62+
63+
- name: Install ovsx
64+
run: npm install -g ovsx
65+
66+
- name: Publish to Open VSX Registry
67+
working-directory: frontend/vscode-extension
68+
run: ovsx publish hatchet-${{ steps.version.outputs.VERSION }}.vsix -p ${{ secrets.OPEN_VSX_REGISTRY_TOKEN }}
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Hatchet VSCode Extension
2+
3+
This is an extension for [Hatchet](https://github.com/hatchet-dev/hatchet) which allows visualization of Hatchet [DAGs](https://docs.hatchet.run/v1/patterns/directed-acyclic-graphs). This works with Hatchet's Python, Typescript, Go and Ruby SDKs.
4+
5+
## Usage
6+
7+
After installation, each Hatchet DAG definition will show a button `Show Hatchet DAG`:
8+
9+
![VSCode Button](./assets/vscode_button.png)
10+
11+
This will then open a webview showing the DAG definition. As you update your definition, the webview will automatically stay up to date:
12+
13+
![Webview](./assets/vscode_dag.png)
14+
15+
## Reporting issues
16+
17+
You can report issues in our [Github issues](https://github.com/hatchet-dev/hatchet/issues).
66.7 KB
Loading
61.1 KB
Loading

0 commit comments

Comments
 (0)