Skip to content

Commit

Permalink
Add details about how to create a release
Browse files Browse the repository at this point in the history
  • Loading branch information
robinjhuang authored Nov 9, 2024
1 parent 87df5f2 commit 7edfd06
Showing 1 changed file with 26 additions and 8 deletions.
34 changes: 26 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ on Windows: %USERPROFILE%\AppData\Roaming\{app name}\logs\main.log

# Development

## Setup Yarn
## Local Server

This project uses `yarn` as its package manager. If you do not already have a `yarn` binary available on your PATH, run:

Expand All @@ -51,6 +51,12 @@ This will install a usable `yarn` binary. Then, in the root directory of this re
yarn install
```

Start the development server:

```bash
yarn start
```

## Setup Python

Make sure you have python 3.12+ installed. It is recommended to setup a virtual environment to run the python code.
Expand Down Expand Up @@ -94,16 +100,28 @@ You can then run `start` to build/launch the code and a live buildserver that wi
yarn start
```

You can also build the package and/or distributables using the `package` and `make` commands:
You can also build the package and/or distributables using the `make` command:

```bash
# build the platform-dependent package
yarn package
# build the platform-dependent package and any distributables
yarn make
```

# Release

We use Todesktop to build and codesign our releases. To make a new release:

1. Make a PR titled "v<semantic version>"
2. Add the label "Release" (case sensitive)
3. Merge the PR
4. A build will automatically start and you can view it at https://app.todesktop.com


### Publish Locally

```bash
# build the platform-dependent package and any distributables
yarn make
# Authentication will be required.
yarn publish
```

## Utility scripts
Expand All @@ -121,8 +139,8 @@ yarn clean:slate

## Windows

x64 [Download](https://updater.comfy.org/windows/latest)
x64 [Download](https://download.comfy.org/windows/nsis/x64)

## Mac

ARM64 [Download](https://updater.comfy.org/darwin/latest)
ARM64 [Download]()

0 comments on commit 7edfd06

Please sign in to comment.