diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000000..e69de29bb2d diff --git a/404.html b/404.html new file mode 100644 index 00000000000..0a551d659c7 --- /dev/null +++ b/404.html @@ -0,0 +1,1688 @@ + + + +
+ + + + + + + + + + + + + + + + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation.
+We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community.
+Examples of behavior that contributes to a positive environment for our +community include:
+Examples of unacceptable behavior include:
+Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful.
+Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate.
+This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event.
+Instances of abusive, harassing, or otherwise unacceptable behavior +may be reported to the community leaders responsible for enforcement +at https://github.com/invoke-ai/InvokeAI/issues. All complaints will +be reviewed and investigated promptly and fairly.
+All community leaders are obligated to respect the privacy and security of the +reporter of any incident.
+Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct:
+Community Impact: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community.
+Consequence: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested.
+Community Impact: A violation through a single incident or series +of actions.
+Consequence: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban.
+Community Impact: A serious violation of community standards, including +sustained inappropriate behavior.
+Consequence: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban.
+Community Impact: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals.
+Consequence: A permanent ban from any sort of public interaction within +the community.
+This Code of Conduct is adapted from the Contributor Covenant, +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+Community Impact Guidelines were inspired by Mozilla's code of conduct +enforcement ladder.
+For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations.
+ + + + + + + + + + + + + + + + + + + + + + + + +The app is published in twice, in different build formats.
+pip install invokeai
. The updater uses this build.Make a developer call-out for PRs to merge. Merge and test things out.
+While the release workflow does not include end-to-end tests, it does pause before publishing so you can download and test the final build.
+The release.yml
workflow runs a number of jobs to handle code checks, tests, build and publish on PyPI.
It is triggered on tag push, when the tag matches v*
. It doesn't matter if you've prepped a release branch like release/v3.5.0
or are releasing from main
- it works the same.
++Because commits are reference-counted, it is safe to create a release branch, tag it, let the workflow run, then delete the branch. So long as the tag exists, that commit will exist.
+
Run make tag-release
to tag the current commit and kick off the workflow.
The release may also be dispatched manually.
+The workflow consists of a number of concurrently-run jobs, and two final publish jobs.
+The publish jobs require manual approval and are only run if the other jobs succeed.
+check-version
Job#This job checks that the git ref matches the app version. It matches the ref against the __version__
variable in invokeai/version/invokeai_version.py
.
When the workflow is triggered by tag push, the ref is the tag. If the workflow is run manually, the ref is the target selected from the Use workflow from dropdown.
+This job uses samuelcolvin/check-python-version.
+++Any valid version specifier works, so long as the tag matches the version. The release workflow works exactly the same for
+RC
,post
,dev
, etc.
python-tests
: runs pytest
on matrix of platformspython-checks
: runs ruff
(format and lint)frontend-tests
: runs vitest
frontend-checks
: runs prettier
(format), eslint
(lint), dpdm
(circular refs), tsc
(static type check) and knip
(unused imports)++TODO We should add
+mypy
orpyright
to thecheck-python
job.TODO We should add an end-to-end test job that generates an image.
+
build-installer
Job#This sets up both python and frontend dependencies and builds the python package. Internally, this runs installer/create_installer.sh
and uploads two artifacts:
dist
: the python distribution, to be published on PyPIInvokeAI-installer-${VERSION}.zip
: the installer to be included in the GitHub releaseAt this point, the release workflow pauses as the remaining publish jobs require approval. Time to test the installer.
+Because the installer pulls from PyPI, and we haven't published to PyPI yet, you will need to install from the wheel:
+dist.zip
and the installer from the Summary tab of the workflow--wheel
CLI arg, pointing at the wheel:++The same wheel file is bundled in the installer and in the
+dist
artifact, which is uploaded to PyPI. You should end up with the exactly the same installation as if the installer got the wheel from PyPI.
If testing reveals any issues, no worries. Cancel the workflow, which will cancel the pending publish jobs (you didn't approve them prematurely, right?).
+Now you can start from the top:
+main
and pull in the fixesmake tag-release
to move the tag to HEAD
(which has the fixes) and kick off the release workflow againThe publish jobs will run if any of the previous jobs fail.
+They use GitHub environments, which are configured as trusted publishers on PyPI.
+Both jobs require a maintainer to approve them from the workflow's Summary tab.
+testpypi
or pypi
)++If the version already exists on PyPI, the publish jobs will fail. PyPI only allows a given version to be published once - you cannot change it. If version published on PyPI has a problem, you'll need to "fail forward" by bumping the app version and publishing a followup release.
+
Check the python infrastructure status page for incidents.
+If there are no incidents, contact @hipsterusername or @lstein, who have owner access to GH and PyPI, to see if access has expired or something like that.
+publish-testpypi
Job#Publishes the distribution on the Test PyPI index, using the testpypi
GitHub environment.
This job is not required for the production PyPI publish, but included just in case you want to test the PyPI release.
+If approved and successful, you could try out the test release like this:
+# Create a new virtual environment
+python -m venv ~/.test-invokeai-dist --prompt test-invokeai-dist
+# Install the distribution from Test PyPI
+pip install --index-url https://test.pypi.org/simple/ invokeai
+# Run and test the app
+invokeai-web
+# Cleanup
+deactivate
+rm -rf ~/.test-invokeai-dist
+
publish-pypi
Job#Publishes the distribution on the production PyPI index, using the pypi
GitHub environment.
Once the release is published to PyPI, it's time to publish the GitHub release.
+scripts/get_external_contributions.py
to get a list of external contributions to shout out in the release notes.build
job into the Assets section of the release notes.++TODO Workflows can create a GitHub release from a template and upload release assets. One popular action to handle this is ncipollo/release-action. A future enhancement to the release process could set this up.
+
The build installer
workflow can be dispatched manually. This is useful to test the installer for a given branch or tag.
No checks are run, it just builds.
+The release
workflow can be dispatched manually. You must dispatch the workflow from the right tag, else it will fail the version check.
This functionality is available as a fallback in case something goes wonky. Typically, releases should be triggered via tag push as described above.
+ + + + + + + + + + + + + + + + + + + + + + + + +