https://github.com/comfy-org/publish-node-action

A Github Action for Publishing Custom Node Version to the Registry
https://github.com/comfy-org/publish-node-action

Last synced: about 1 year ago
JSON representation

A Github Action for Publishing Custom Node Version to the Registry

• Host: GitHub
• URL: https://github.com/comfy-org/publish-node-action
• Owner: Comfy-Org
• License: mit
• Created: 2024-05-07T20:54:41.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-20T21:12:28.000Z (over 1 year ago)
• Last Synced: 2025-02-10T12:18:28.421Z (over 1 year ago)
• Homepage: https://registry.comfy.org
• Size: 241 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# publish-node-action

Uses [comfy-cli](https://github.com/Comfy-Org/comfy-cli) to publish the current version of your custom node to the [registry](https://comfyregistry.org). The goal is to create an easy way for developers to publish updates to their custom node to the registry.

## Getting Started

### Publish Node

Please finish the guide [here](https://www.comfydocs.org/registry/overview#publishing-to-the-registry) for publishing to the registry befre continuing.

Make sure you have:

- [ ] Created a publisher

- [ ] Created a personal access token

- [ ] Generated a pyproject.toml file for your custom node

### Add Personal Access Token to Secrets

Add the personal access token you created on the registry website to your Github Secrets.

Go to Settings -> Secrets and Variables -> Actions -> New repository secret.

Create a secret called `REGISTRY_ACCESS_TOKEN`.

![Repository Secrets](images/repo_secrets.png)

![Add Secret](images/add_secret.png)

### Publish when pyproject.toml changes

The easiest way to publish custom node versions is to use this Github Actions workflow that runs everytime `pyproject.toml` changes. When you want to publish a new version, simply go and update the version field to the next version.

```yaml

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 }} ## Add your own personal access token to your Github Repository secrets and reference it here.

```

### Notes

`comfy-cli` will publish the version written in `pyproject.toml`.

Make sure you update this before running the Github Action.

```toml

[project]

version = "1.0.1"

```