summaryrefslogtreecommitdiffstats
path: root/taskcluster/docker/python-dependency-update/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'taskcluster/docker/python-dependency-update/README.md')
-rw-r--r--taskcluster/docker/python-dependency-update/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/taskcluster/docker/python-dependency-update/README.md b/taskcluster/docker/python-dependency-update/README.md
new file mode 100644
index 0000000000..ab560623ee
--- /dev/null
+++ b/taskcluster/docker/python-dependency-update/README.md
@@ -0,0 +1,15 @@
+
+==Python Dependency Updates==
+
+This docker image contains the necessary dependencies and scripts to update
+in-tree requirement.txt produced by `pip-compile --generate-hashes`, produce a
+diff, and submit it to Phabricator.
+
+
+==Quick Start==
+
+```sh
+docker build -t python-dependency-update --no-cache --rm .
+
+docker run -e PYTHON3="1" -e BRANCH="mozilla-central" -e REQUIREMENTS_FILE="taskcluster/docker/funsize-update-generator/requirements.in" python-dependency-update
+```