You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[feat] add GitHub Actions workflow for automated building and publishing
Implements CI/CD pipeline that automatically builds React extension and publishes to ComfyUI Registry. Updates README with clear installation instructions distinguishing registry vs manual installation.
Copy file name to clipboardExpand all lines: README.md
+24-4Lines changed: 24 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,18 @@ A minimal template for creating React/TypeScript frontend extensions for ComfyUI
18
18
19
19
## Installation
20
20
21
+
### From ComfyUI Registry (Recommended)
22
+
23
+
The easiest way to install this extension is through the ComfyUI Manager:
24
+
25
+
1. Open ComfyUI and go to the Manager
26
+
2. Search for "React Extension Template"
27
+
3. Click Install
28
+
29
+
### Manual Installation
30
+
31
+
If you want to install directly from GitHub for development purposes:
32
+
21
33
```bash
22
34
# Go to your ComfyUI custom_nodes directory
23
35
cd ComfyUI/custom_nodes
@@ -33,6 +45,8 @@ npm run build
33
45
# Restart ComfyUI
34
46
```
35
47
48
+
⚠️ **Important**: When installing manually from GitHub, you **must** run `npm run build` in the `ui/` directory before the extension will work. The extension requires the compiled React code in the `dist/` folder to function properly in ComfyUI.
49
+
36
50
## Usage
37
51
38
52
This template includes a simple example extension that displays workflow node statistics. After installation:
@@ -84,7 +98,7 @@ For comprehensive documentation on all available APIs, see the [ComfyUI JavaScri
84
98
ComfyUI-React-Extension-Template/
85
99
├── .github/ # GitHub configurations
86
100
│ └── workflows/
87
-
│ └── publish.yml # Automatic publishing workflow
101
+
│ └── react-build.yml # Automatic build and publishing workflow
88
102
├── __init__.py # Python entry point for ComfyUI integration
89
103
├── pyproject.toml # Project metadata for ComfyUI Registry
90
104
├── dist/ # Built extension files (generated)
@@ -166,9 +180,15 @@ This template includes a GitHub Actions workflow that automatically publishes to
166
180
3. Commit and push an update to pyproject.toml (e.g., increment the version number)
167
181
4. The GitHub Action will automatically run and publish your extension
168
182
169
-
The workflow configuration is already set up in `.github/workflows/publish.yml` and will trigger when:
170
-
- The `pyproject.toml` file is modified
171
-
- The changes are pushed to the `main` branch
183
+
The workflow configuration is set up in `.github/workflows/react-build.yml` and will trigger when:
184
+
- Changes are pushed to the `main` branch
185
+
- Pull requests are created against the `main` branch
186
+
187
+
The workflow automatically:
188
+
1. Sets up Node.js environment
189
+
2. Installs dependencies (`npm install`)
190
+
3. Builds the React extension (`npm run build`)
191
+
4. Publishes the extension to the ComfyUI Registry
0 commit comments