How to build "binary" installers (InvokeAI-mac/windows/linux_on_*.zip)#
installers/requirements.in is correct#
and up to date on the branch to be installed.
pip-compile on each platform.#
On each target platform, in the branch that is to be installed, and inside the InvokeAI git root folder, run the following commands:
<reqsfile>.txtis whichever of
There is no way to cross-compile these. They must be done on a system matching the target OS and arch.
3. Set github repository and branch#
Once all reqs files have been collected and committed to the branch
to be installed, edit
binary_installer/install.bat.in so that
RELEASE_SOURCEBALL point to the github repo and branch that is
to be installed.
For example, to install
main branch of
InvokeAI, they should be
set as follows:
Or, to install
damians-cool-feature branch of
damian0815, set them
The branch and repo specified here must contain the correct reqs files. The installer zip files do not contain requirements files, they are pulled from the specified branch during the installation process.
4. Create zip files.#
cd into the
installers/ folder and run
./create_installers.sh. This will create
InvokeAI-linux_on_<branch>.zip. These files can be distributed to end users.
These zips will continue to function as installers for all future
pushes to those branches, as long as necessary changes to
requirements.in are propagated in a timely manner to the
py3.10-*-reqs.txt files using pip-compile as outlined in step
To actually install, users should unzip the appropriate zip file into an empty
folder and run
install.sh on macOS/Linux or
Created: December 1, 2022