From 7119480f84dd6aad6fe94372c0f5faeeada47866 Mon Sep 17 00:00:00 2001 From: filtered <176114999+webfiltered@users.noreply.github.com> Date: Sat, 8 Mar 2025 16:20:21 +1100 Subject: [PATCH] [CI] Add pre-release options (#722) Adds release steps to README. --- .github/workflows/release-version.yml | 7 ++++++- README.md | 19 +++++++++++++++++++ 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/.github/workflows/release-version.yml b/.github/workflows/release-version.yml index c35fd10f71..10b034f73c 100644 --- a/.github/workflows/release-version.yml +++ b/.github/workflows/release-version.yml @@ -9,7 +9,12 @@ on: required: true default: patch type: choice - options: [patch, minor, major] + options: [patch, minor, major, prepatch, preminor, premajor, prerelease] + pre_release: + description: Pre-release ID (suffix) + required: false + default: "" + type: string jobs: bump-version: diff --git a/README.md b/README.md index d5b6e3244b..1d79f8c7ce 100755 --- a/README.md +++ b/README.md @@ -138,6 +138,25 @@ graph.start() Please [open an issue](https://github.com/Comfy-Org/litegraph.js/issues/) on the GitHub repo. +# Development + +Litegraph has no runtime dependencies. The build tooling has been tested on Node.JS 20.18.x + +## Releasing + +Use GitHub actions to release normal versions. + +1. Run the `Release a New Version` action, selecting the version incrment type +1. Merge the resultion PR +1. A GitHub release is automatically published on merge + +### Pre-release + +The action directly translates `Version increment type` to the npm version command. `Pre-release ID (suffix)` is the option for the `--preid` argument. + +e.g. Use `prerelease` increment type to automatically bump the patch version and create a pre-release version. Subsequent runs of prerelease will update the prerelease version only. +Use `patch` when ready to remove the pre-release suffix. + ## Contributors You can find the [current list of contributors](https://github.com/Comfy-Org/litegraph.js/graphs/contributors) on GitHub.