Add helper task to update dependencies (#10447)

When there is the need to add a new dependency,
we have to update each file one by one,
instead of doing that, I'm creating an invoke task.

Author: stsewd

.github/workflows/pip-tools.yaml

@@ -27,25 +27,15 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: "3.10"
-      - name: Install test dependencies
-        run: python -m pip install -U pip-tools
-
-      - name: Run pip-compile on requirements/pip.in
-        run: pip-compile --upgrade --resolver=backtracking --output-file=requirements/pip.txt requirements/pip.in
-
-      - name: Run pip-compile on requirements/docker.in
-        run: pip-compile --upgrade --resolver=backtracking --output-file=requirements/docker.txt requirements/docker.in
-
-      - name: Run pip-compile on requirements/testing.in
-        run: pip-compile --upgrade --resolver=backtracking --output-file=requirements/testing.txt requirements/testing.in
-
-      - name: Run pip-compile on requirements/docs.in
-        run: pip-compile --upgrade --resolver=backtracking --output-file=requirements/docs.txt requirements/docs.in
 
       - name: Install "pg_config" requirement
         run: sudo apt-get install libpq-dev
-      - name: Run pip-compile on requirements/deploy.in
-        run: pip-compile --upgrade --resolver=backtracking --output-file=requirements/deploy.txt requirements/deploy.in
+
+      - name: Install piptools and invoke
+        run: python -m pip install -U pip-tools invoke
+
+      - name: Update dependencies from requirements/*.txt
+        run: invoke requirements.update
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v5

tasks.py

@@ -16,41 +16,73 @@
     Collection(
         common.tasks.setup_labels,
     ),
-    name='github',
+    name="github",
 )
 
 namespace.add_collection(
     Collection.from_module(
         common.dockerfiles.tasks,
         config={
-            'container_prefix': 'community',
+            "container_prefix": "community",
         },
     ),
-    name='docker',
+    name="docker",
 )
 
+
 @task
 def docs(ctx, regenerate_config=False, push=False):
-    """Pull and push translations to Transifex for our docs"""
-    with ctx.cd(os.path.join(ROOT_PATH, 'docs')):
+    """Pull and push translations to Transifex for our docs."""
+    with ctx.cd(os.path.join(ROOT_PATH, "docs")):
         # Update our translations
-        ctx.run('tx pull -a')
+        ctx.run("tx pull -a")
         # Update resources
         if regenerate_config:
-            os.remove(os.path.join(ROOT_PATH, 'docs', '.tx', 'config'))
-            ctx.run('sphinx-intl create-txconfig')
-        ctx.run('sphinx-intl update-txconfig-resources --transifex-project-name readthedocs-docs')
+            os.remove(os.path.join(ROOT_PATH, "docs", ".tx", "config"))
+            ctx.run("sphinx-intl create-txconfig")
+        ctx.run(
+            "sphinx-intl update-txconfig-resources --transifex-project-name readthedocs-docs"
+        )
         # Rebuild
-        ctx.run('sphinx-intl build')
-        ctx.run('make gettext')
+        ctx.run("sphinx-intl build")
+        ctx.run("make gettext")
         # Push new ones
         if push:
-            ctx.run('tx push -s')
+            ctx.run("tx push -s")
 
 
 namespace.add_collection(
     Collection(
         docs,
     ),
-    name='l10n',
+    name="l10n",
+)
+
+
+@task(
+    help={
+        "package": "If specified, only update this package",
+    }
+)
+def update(ctx, package=None):
+    """Update Python dependencies from requirements/*.txt."""
+    cmd = ["pip-compile", "--resolver=backtracking"]
+    if package:
+        cmd.extend(["--upgrade-package", package])
+    else:
+        cmd.append("--upgrade")
+    files = [
+        "requirements/pip",
+        "requirements/docker",
+        "requirements/testing",
+        "requirements/docs",
+        "requirements/deploy",
+    ]
+    for file in files:
+        ctx.run(" ".join(cmd) + f" --output-file {file}.txt {file}.in")
+
+
+namespace.add_collection(
+    Collection(update),
+    name="requirements",
 )