|
@@ -345,3 +345,21 @@ pre-commit install
|
|
|
```
|
|
|
|
|
|
pre-commit should now run on every commit you make.
|
|
|
+
|
|
|
+(developing_using_a_fork)
|
|
|
+
|
|
|
+## Using forks for installation
|
|
|
+
|
|
|
+Sometimes it may be necessary to install Wagtail from a fork. For example your site depends on a bug fix that is currently waiting for review, and you cannot afford waiting for a new release.
|
|
|
+
|
|
|
+The Wagtail release process includes steps for static asset building and translations updated which means you cannot update your requirements file to point a particular git commit in the main repository.
|
|
|
+
|
|
|
+To install from your fork, from the root of your Wagtail git checkout (and assuming the tooling for building the static assets has previously been installed using `npm install`), run:
|
|
|
+
|
|
|
+```sh
|
|
|
+python ./setup.py sdist
|
|
|
+```
|
|
|
+
|
|
|
+This will create a `.tar.gz` package within `dist/,` which can be installed with `pip`.
|
|
|
+
|
|
|
+For remote deployments, it's usually most convenient to upload this to a public URL somewhere and place that URL in your project's requirements in place of the standard `wagtail` line.
|