Merge pull request #4 from Visionatrix/main

v0.5.0

.github/workflows/docs.yml

@@ -1,7 +1,9 @@
 name: Docs
 on:
   push:
-    branches: [ main ]
+    branches:
+      - main
+      - 'version-*'
 
 permissions:
   contents: read
@@ -12,15 +14,26 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - uses: actions/setup-python@v5
         with:
           python-version: '3.10'
 
       - name: Install Docs dependencies
         run: python3 -m pip install -r requirements.txt
 
-      - name: Zip the flows folder
-        run: zip -r flows.zip flows
+      - name: Build flows for each version
+        run: |
+          set -e
+          mkdir flows_publish
+          for branch in $(git branch -r | grep -E 'origin/version-'); do
+            git checkout --track "$branch"
+            version=$(echo "$branch" | sed -E 's/origin\/version-([0-9\.]+)/\1/')
+            zip -r "flows_publish/flows-$version.zip" flows
+          done
+          git checkout main
+          zip -r flows_publish/flows.zip flows
 
       - name: Build and push Docs
         run: |
@@ -30,7 +43,7 @@ jobs:
           git config --global user.email "bigcat88@users.noreply.github.com"
           docroot=`mktemp -d`
           rsync -av "docs/_build/html/" "${docroot}/"
-          rsync -av "flows.zip" "${docroot}/"
+          rsync -av "flows_publish/" "${docroot}/"
           rsync -av "models_catalog.json" "${docroot}/"
           pushd "${docroot}"
           git init

.gitignore

@@ -102,3 +102,4 @@ vix_worker_tasks_files
 scripts/visionatrix
 tasks_history.db
 /flows.zip
+flows_publish

docs/Flows/SD3_Medium.rst

@@ -36,4 +36,4 @@ Prompt: "*poster, cyborg girl against an alien, black baground, high contrast, h
 
 .. image:: /FlowsResults/SD3_Medium_3.png
 
-Prompt: "*an oil line art painting of the angel impressive neon shadows, warm colors*" | prompt_strength: 4.1 (seed: 1167357)
+Prompt: "*an oil line art painting of the angel impressive neon shadows, warm colors*" | prompt_strength: 4.1 (seed: 1167357)

docs/GatedModels.rst

@@ -26,4 +26,4 @@ I'm a user and want to connect my own worker to process flows with closed models
 As user's workers cannot receive global access tokens from the server to avoid leaks, you have two options:
 
 1. Download the model yourself and place it in the folder specified in ``models_catalog.json`` under the ``save_path`` key.
-2. Set the ``HF_AUTH_TOKEN`` environment variable with your own public access token, and the worker will be able to install flows with gated models.
+2. Set the ``HF_AUTH_TOKEN`` environment variable with your own public access token, and the worker will be able to install flows with gated models.

docs/TechnicalInformation.rst

@@ -1,7 +1,10 @@
 Technical Information
 =====================
 
-Currently installed ComfyUI nodes:
+Bundled ComfyUI nodes
+---------------------
+
+Visionatrix by default install and update these nodes:
 
  * `ComfyUI-Impact-Pack <https://github.com/Visionatrix/ComfyUI-Impact-Pack>`_
  * `ComfyUI_InstantID <https://github.com/Visionatrix/ComfyUI_InstantID>`_
@@ -17,5 +20,67 @@ Currently installed ComfyUI nodes:
  * `ComfyUI-AutomaticCFG <https://github.com/Visionatrix/ComfyUI-AutomaticCFG>`_
 
 We are gradually expanding the list.
-The main reason many components are missing is that they are quite difficult to install and we take the position
-that an easy installation process is more important in most cases.
+
+The main reason many components are missing is that they are quite difficult to install, and we believe that an easy installation process is more important in most cases.
+
+
+Workflows storage
+-----------------
+
+All public flows are located in `VixFlowsDocs <https://github.com/Visionatrix/VixFlowsDocs>`_ repository.
+
+The repository consists of a development branch **main** and a set of branches **version-X.Y**:
+
+* version-0.5
+* version-0.6
+* ...
+* version-1.0
+* version-1.1
+* main
+
+Sets of public workflows are packaged in the root of the documentation and have the following form:
+
+* flows-0.5.zip
+* flows-0.6.zip
+* ...
+* flows-1.0.zip
+* flows-1.1.zip
+* flows.zip
+
+The development version of Visionatrix fetches the ``flows.zip`` archive by default.
+
+Release versions of Visionatrix fetch sets of flows for their version.
+
+The ``FLOWS_URL`` variable in Visionatrix has the default value of ``https://visionatrix.github.io/VixFlowsDocs/``
+
+When **FLOWS_URL** ends with "/", the Visionatrix fetches an archive with flows for its version.
+
+.. note::
+    You can also specify a specific path/URL to the archive file with flows, and only that will be used.
+
+
+Update algorithm of Visionatrix
+-------------------------------
+
+Developer versions are updated only to development versions, release versions only to release ones.
+
+.. note::
+    If you are not a developer, you are better off using the release version, as they should be more stable.
+
+It is recommended to update Vix with the ``easy_install.py`` script.
+
+The update scheme in `easy_install.py <https://github.com/Visionatrix/Visionatrix/blob/main/scripts/easy_install.py>`_ is quite simple; everything is done with ordinary Git commands.
+
+* If the current version is a dev release or the current branch is ``main`` then:
+
+    1. Check out the ``main`` branch.
+    2. Pull the latest changes from the remote repository.
+
+* If the current version is a tagged release version:
+
+    1. Determine the latest tag for the current major version, and if a newer version tag is found, check out the latest version tag within the current major version.
+    2. If no newer version is found within the current major version, check for the next major version.
+    3. If a newer major version tag is found, prompt the user to update to this newer major version.
+
+* After checking out the appropriate version, run a ``pip install`` command to update the Python packages.
+* Finally, run the ``python3 -m visionatrix update`` command to ensure that any additional necessary updates are applied (ComfyUI, custom nodes, flows).

flows/colorful_xl/flow.json

@@ -134,4 +134,4 @@
       }
     }
   ]
-}
+}

flows/colorful_xl/flow_comfy.json

@@ -184,4 +184,4 @@
       "title": "VAE Decode"
     }
   }
-}
+}

flows/mobius_xl/flow.json

@@ -84,4 +84,4 @@
       }
     }
   ]
-}
+}

flows/mobius_xl/flow_comfy.json

@@ -197,4 +197,4 @@
       "title": "CLIP Set Last Layer"
     }
   }
-}
+}

flows/sd3_medium/flow.json

@@ -132,4 +132,4 @@
       }
     }
   ]
-}
+}

flows/sd3_medium/flow_comfy.json

@@ -104,4 +104,4 @@
       "title": "@Datou"
     }
   }
-}
+}