Use appropriate name for versioned website helper script

per1234 · per1234 · commit a4bae33a8ecb · 2021-06-23T21:49:37.000-07:00
Now that the purpose of the versioned website helper script is exclusively to determine the versioning parameters, the
previous "build.py" filename was not an accurate representation of its purpose.
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -231,7 +231,7 @@ tasks:
     deps:
       - task: poetry:install-deps
     cmds:
-      - poetry run pytest workflow-templates/assets/deploy-mkdocs-versioned/build/tests
+      - poetry run pytest workflow-templates/assets/deploy-mkdocs-versioned/siteversion/tests
 
   # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-python-task/Taskfile.yml
   python:lint:
diff --git a/workflow-templates/assets/deploy-mkdocs-versioned/siteversion/siteversion.py b/workflow-templates/assets/deploy-mkdocs-versioned/siteversion/siteversion.py
@@ -1,5 +1,5 @@
 # Source:
-# https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/deploy-mkdocs-versioned/build/build.py
+# https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/deploy-mkdocs-versioned/siteversion/siteversion.py
 
 # Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
 
@@ -89,7 +89,7 @@ def main():
 
 # Usage:
 #     To run the script (must be run from within the repo tree):
-#         $python build.py
+#         $python siteversion.py
 #
 if __name__ == "__main__":
     main()
diff --git a/workflow-templates/assets/deploy-mkdocs-versioned/siteversion/tests/__init__.py b/workflow-templates/assets/deploy-mkdocs-versioned/siteversion/tests/__init__.py
diff --git a/workflow-templates/assets/deploy-mkdocs-versioned/siteversion/tests/pytest.ini b/workflow-templates/assets/deploy-mkdocs-versioned/siteversion/tests/pytest.ini
diff --git a/workflow-templates/assets/deploy-mkdocs-versioned/siteversion/tests/test_all.py b/workflow-templates/assets/deploy-mkdocs-versioned/siteversion/tests/test_all.py
@@ -1,5 +1,5 @@
 # Source:
-# https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/deploy-mkdocs-versioned/build/test/test_all.py
+# https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/deploy-mkdocs-versioned/siteversion/test/test_all.py
 
 # Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
 
@@ -12,22 +12,22 @@
 # modify or otherwise use the software for commercial activities involving the
 # Arduino software without disclosing the source code of your own applications.
 # To purchase a commercial license, send an email to license@arduino.cc.
-import build
+import siteversion
 
 
 def test_get_docs_version():
-    data = build.get_docs_version("main", [])
+    data = siteversion.get_docs_version("main", [])
     assert data["version"] == "dev"
     assert data["alias"] == ""
 
     release_names = ["1.4.x", "0.13.x"]
-    data = build.get_docs_version("0.13.x", release_names)
+    data = siteversion.get_docs_version("0.13.x", release_names)
     assert data["version"] == "0.13"
     assert data["alias"] == ""
-    data = build.get_docs_version("1.4.x", release_names)
+    data = siteversion.get_docs_version("1.4.x", release_names)
     assert data["version"] == "1.4"
     assert data["alias"] == "latest"
 
-    data = build.get_docs_version("0.1.x", [])
+    data = siteversion.get_docs_version("0.1.x", [])
     assert data["version"] is None
     assert data["alias"] is None
diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/deploy-mkdocs-versioned-poetry.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/deploy-mkdocs-versioned-poetry.yml
@@ -4,7 +4,7 @@ name: Deploy Website
 on:
   push:
     branches:
-      # Branch to base "dev" website on. Set in build.py also.
+      # Branch to base "dev" website on. Set in siteversion.py also.
       - main
       # Release branches have names like 0.8.x, 0.9.x, ...
       - "[0-9]+.[0-9]+.x"
@@ -66,7 +66,7 @@ jobs:
 
       - name: Determine versioning parameters
         id: determine-versioning
-        run: echo "::set-output name=data::$(poetry run python docs/build/build.py)"
+        run: echo "::set-output name=data::$(poetry run python docs/siteversion/siteversion.py)"
 
       - name: Publish documentation
         if: fromJson(steps.determine-versioning.outputs.data).version != null
diff --git a/workflow-templates/deploy-mkdocs-versioned-poetry.md b/workflow-templates/deploy-mkdocs-versioned-poetry.md
@@ -20,8 +20,8 @@ The website version is selectable via a menu on the website as well as the URL o
 - [deploy-mkdocs-versioned-poetry.yml](deploy-mkdocs-versioned-poetry.yml) - GitHub Actions workflow
   - Install to: `.github/workflows/`
 - Base assets - See the ["Deploy Website" workflow (MkDocs, Poetry) documentation](deploy-mkdocs-poetry.md#assets)
-- [build](assets/deploy-mkdocs-versioned/build/) - versioning helper script.
-  - Install to: `docs/build/`
+- [siteversion](assets/deploy-mkdocs-versioned/siteversion/) - versioning helper script.
+  - Install to: `docs/siteversion/`
 - [`Taskfile.yml`](assets/deploy-mkdocs-versioned/Taskfile.yml) - website deployment task
   - Install to: repository root (or merge into the existing `Taskfile.yml`)
 
@@ -38,7 +38,7 @@ See the ["Deploy Website" workflow (MkDocs, Poetry) documentation](deploy-mkdocs
 The system is configured for the repository branch used as the source for the "dev" website version having the name `main`. If the project's development branch has another name, then configure it:
 
 - `on.push.branches[0]` in `deploy-mkdocs-versioned-poetry.yml`
-- `DEV_BRANCHES` in [`build/build.py`](assets/deploy-mkdocs-versioned/build/build.py)
+- `DEV_BRANCHES` in [`siteversion/siteversion.py`](assets/deploy-mkdocs-versioned/siteversion/siteversion.py)
 
 #### Configure Material theme for versioning
 
diff --git a/workflow-templates/deploy-mkdocs-versioned-poetry.yml b/workflow-templates/deploy-mkdocs-versioned-poetry.yml
@@ -4,7 +4,7 @@ name: Deploy Website
 on:
   push:
     branches:
-      # Branch to base "dev" website on. Set in build.py also.
+      # Branch to base "dev" website on. Set in siteversion.py also.
       - main
       # Release branches have names like 0.8.x, 0.9.x, ...
       - "[0-9]+.[0-9]+.x"
@@ -66,7 +66,7 @@ jobs:
 
       - name: Determine versioning parameters
         id: determine-versioning
-        run: echo "::set-output name=data::$(poetry run python docs/build/build.py)"
+        run: echo "::set-output name=data::$(poetry run python docs/siteversion/siteversion.py)"
 
       - name: Publish documentation
         if: fromJson(steps.determine-versioning.outputs.data).version != null
