Custom Node CI/CD

Test ComfyUI custom nodes before publishing using Comfy-Action to run workflows on GitHub Actions and view results in the CI/CD Dashboard.

Introduction

When making changes to custom nodes, it’s not uncommon to break things in Comfy or other custom nodes. It is often unrealistic to test on every operating system and different configurations of Pytorch.

Run Comfy Workflows using Github Actions

Comfy-Action allows you to run a Comfy workflow.json file on Github Actions. It supports downloading models, custom nodes, and runs on Linux/Mac/Windows.

Results

Output files are uploaded to the CI/CD Dashboard and can be viewed as a last step before committing new changes or publishing new versions of the custom node.

Publish versions from GitHub Actions

Publish Node Action publishes the version in your pyproject.toml to the Registry, so bumping the version is all it takes to release. Add your Registry access token as a repository secret named REGISTRY_ACCESS_TOKEN in Settings > Secrets and variables > Actions, then add this workflow:

name: Publish to Comfy registry
on:
  workflow_dispatch:
  push:
    branches:
      - main
    paths:
      - "pyproject.toml"

jobs:
  publish-node:
    name: Publish Custom Node to registry
    runs-on: ubuntu-latest
    steps:
      - name: Check out code
        uses: actions/checkout@v4
      - name: Publish Custom Node
        uses: Comfy-Org/publish-node-action@main
        with:
          personal_access_token: ${{ secrets.REGISTRY_ACCESS_TOKEN }}

The published version is the version field in pyproject.toml. Update it before the workflow runs.