From 0d3b0d54e73c05226c121064bb576871f8cb412c Mon Sep 17 00:00:00 2001
From: Erik Sundell <erik.i.sundell@gmail.com>
Date: Wed, 2 Mar 2022 02:18:07 +0100
Subject: [PATCH] Cleanup requirements.txt and dev-requirements.txt

---
 .github/actions/deploy/action.yml              |  1 -
 .../workflows/deploy-grafana-dashboards.yaml   |  1 -
 .github/workflows/deploy-hubs.yaml             |  1 -
 .github/workflows/doc-links.yml                |  5 -----
 dev-requirements.txt                           | 14 +++++++++++---
 docs/reference/ci-cd.md                        |  1 -
 requirements.txt                               | 18 +++++++++++++++---
 7 files changed, 26 insertions(+), 15 deletions(-)

diff --git a/.github/actions/deploy/action.yml b/.github/actions/deploy/action.yml
index e57c8f5023..56f4f92991 100644
--- a/.github/actions/deploy/action.yml
+++ b/.github/actions/deploy/action.yml
@@ -19,7 +19,6 @@ runs:
     - name: Setup dependencies
       run: |
         python3 -m pip install -r requirements.txt
-        python3 -m pip install -r dev-requirements.txt
       shell: bash
     - name: Deploy support components
       run: |
diff --git a/.github/workflows/deploy-grafana-dashboards.yaml b/.github/workflows/deploy-grafana-dashboards.yaml
index 2c9832b5a7..52a3e48cff 100644
--- a/.github/workflows/deploy-grafana-dashboards.yaml
+++ b/.github/workflows/deploy-grafana-dashboards.yaml
@@ -22,7 +22,6 @@ jobs:
       - name: Setup dependencies
         run: |
           python3 -m pip install -r requirements.txt
-          python3 -m pip install -r dev-requirements.txt
           sudo apt install jsonnet
 
       - name: Setup gcloud
diff --git a/.github/workflows/deploy-hubs.yaml b/.github/workflows/deploy-hubs.yaml
index feeb54c64c..5f34af6df8 100644
--- a/.github/workflows/deploy-hubs.yaml
+++ b/.github/workflows/deploy-hubs.yaml
@@ -63,7 +63,6 @@ jobs:
               - "deployer/**"
               - "helm-charts/**"
               - "requirements.txt"
-              - "dev-requirements.txt"
               - "config/secrets.yaml"
               - ".github/workflows/deploy-hubs.yaml"
               - ".github/actions/deploy/*"
diff --git a/.github/workflows/doc-links.yml b/.github/workflows/doc-links.yml
index 9f782bc0b1..120a9624af 100644
--- a/.github/workflows/doc-links.yml
+++ b/.github/workflows/doc-links.yml
@@ -13,11 +13,6 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v2
-        with:
-          # chartpress is used by doc/conf.py,
-          # and requires information about the latest tagged commit, which
-          # requires the git history.
-          fetch-depth: 0
 
       - name: Install environment
         uses: conda-incubator/setup-miniconda@v2
diff --git a/dev-requirements.txt b/dev-requirements.txt
index 4f81875cca..5d92dc7bd2 100644
--- a/dev-requirements.txt
+++ b/dev-requirements.txt
@@ -1,5 +1,13 @@
-pytest
-pytest-asyncio
+# These requirements represents the needs for doing various tasks in this git
+# repo besides using the deployer script.
+#
+
+# chartpress is relevant to build and push helm-charts/images/hub/Dockerfile and
+# update basehub's default values to reference the new image.
+chartpress
+
+# requests is used by extra_scripts/rsync-active-users.py
 requests
-beautifulsoup4
+
+# rich is used by extra_scripts/count-auth0-apps.py
 rich
diff --git a/docs/reference/ci-cd.md b/docs/reference/ci-cd.md
index 7646574c16..d3c2deb681 100644
--- a/docs/reference/ci-cd.md
+++ b/docs/reference/ci-cd.md
@@ -11,7 +11,6 @@ following paths are modified:
 - deployer/**
 - helm-charts/**
 - requirements.txt
-- dev-requirements.txt
 - config/secrets.yaml
 - config/clusters/**
 - .github/workflows/deploy-hubs.yaml
diff --git a/requirements.txt b/requirements.txt
index c72318ec25..9e172679bf 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,6 +1,18 @@
-backoff
-chartpress
+# This file represents the needs for the deployer script to function, while the
+# dev-requirements.txt file represents the needs in this repo in general.
+#
+
+# ruamel.yaml is used to read and write .yaml files.
 ruamel.yaml
+
+# auth0 is used to communicate with Auth0's REST API that we integrate with in
+# various ways.
 auth0-python
-jhub-client==0.1.4
+
+# jsonschema is used for validating cluster.yaml configurations
 jsonschema
+
+# jhub_client, pytest, and pytest_asyncio are used for our health checks
+jhub-client==0.1.4
+pytest
+pytest-asyncio