From 781126719ab9911506f1f602703e7b61a90fb365 Mon Sep 17 00:00:00 2001
From: Sam Freund <techguy763@gmail.com>
Date: Fri, 11 Apr 2025 15:33:27 -0500
Subject: [PATCH] Rename Workflows (#1881)

## Description

Rename some of the workflows and the steps within the workflows to
provide further clarity as to what they affect. Additionally, rename the
RtD workflow file to differentiate it from the javadocs/doxygen
workflow.

closes #1880

## Meta

Merge checklist:
- [X] Pull Request title is [short, imperative
summary](https://cbea.ms/git-commit/) of proposed changes
- [X] The description documents the _what_ and _why_
- [X] If this PR changes behavior or adds a feature, user documentation
is updated
- [X] If this PR touches photon-serde, all messages have been
regenerated and hashes have not changed unexpectedly
- [X] If this PR touches configuration, this is backwards compatible
with settings back to v2024.3.1
- [X] If this PR addresses a bug, a regression test for it is added
---
 .github/workflows/photon-api-docs.yml              | 14 ++++++--------
 ...{photonvision-docs.yml => photonvision-rtd.yml} |  3 ++-
 .github/workflows/website.yml                      |  9 +++++----
 3 files changed, 13 insertions(+), 13 deletions(-)
 rename .github/workflows/{photonvision-docs.yml => photonvision-rtd.yml} (93%)

diff --git a/.github/workflows/photon-api-docs.yml b/.github/workflows/photon-api-docs.yml
index c36375b35..332490c14 100644
--- a/.github/workflows/photon-api-docs.yml
+++ b/.github/workflows/photon-api-docs.yml
@@ -22,6 +22,7 @@ permissions:
 
 jobs:
   build_demo:
+    name: Build PhotonClient Demo
     defaults:
       run:
         working-directory: photon-client
@@ -42,6 +43,7 @@ jobs:
           path: photon-client/dist/
 
   run_api_docs:
+    name: Build API Docs
     runs-on: "ubuntu-22.04"
     steps:
     - name: Checkout code
@@ -55,30 +57,26 @@ jobs:
       with:
         java-version: 17
         distribution: temurin
-
     - name: Build javadocs/doxygen
       run: |
         chmod +x gradlew
         ./gradlew photon-docs:generateJavaDocs photon-docs:doxygen
-
     - uses: actions/upload-artifact@v4
       with:
         name: built-docs
         path: photon-docs/build/docs
 
   publish_api_docs:
+    name: Publish API Docs
     needs: [run_api_docs]
-
     runs-on: ubuntu-22.04
     steps:
-
       # Download docs artifact
       - uses: actions/download-artifact@v4
         with:
           name: built-docs
-
       - run: find .
-      - name: Publish docs to development
+      - name: Publish Docs To Development
         if: github.ref == 'refs/heads/main'
         uses: up9cloud/action-rsync@v1.4
         env:
@@ -86,7 +84,7 @@ jobs:
           USER: ${{ secrets.WEBMASTER_SSH_USERNAME }}
           KEY: ${{secrets.WEBMASTER_SSH_KEY}}
           TARGET: /var/www/html/photonvision-docs/development
-      - name: publish docs to release
+      - name: Publish Docs To Release
         if: startsWith(github.ref, 'refs/tags/v')
         uses: up9cloud/action-rsync@v1.4
         env:
@@ -96,8 +94,8 @@ jobs:
           TARGET: /var/www/html/photonvision-docs/release/
 
   publish_demo:
+      name: Publish PhotonClient Demo
       needs: [build_demo]
-
       runs-on: ubuntu-22.04
       steps:
       - uses: actions/download-artifact@v4
diff --git a/.github/workflows/photonvision-docs.yml b/.github/workflows/photonvision-rtd.yml
similarity index 93%
rename from .github/workflows/photonvision-docs.yml
rename to .github/workflows/photonvision-rtd.yml
index 990a10b46..ed9e8f2ec 100644
--- a/.github/workflows/photonvision-docs.yml
+++ b/.github/workflows/photonvision-rtd.yml
@@ -1,4 +1,4 @@
-name: PhotonVision Sphinx Documentation Checks
+name: PhotonVision ReadTheDocs Checks
 
 on:
   push:
@@ -16,6 +16,7 @@ env:
 
 jobs:
   build:
+    name: Build and Check Docs
     runs-on: ubuntu-22.04
 
     steps:
diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml
index 53891eb3f..ff2acaaa7 100644
--- a/.github/workflows/website.yml
+++ b/.github/workflows/website.yml
@@ -1,4 +1,4 @@
-name: Website Build
+name: Website
 
 on:
   push:
@@ -12,6 +12,7 @@ on:
 
 jobs:
   rsync:
+    name: Build and Sync Files
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -33,15 +34,15 @@ jobs:
           TARGET: /var/www/html/photonvision-website
 
   format-check:
-    name: Check formatting
+    name: Check Formatting
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - name: Setup Node
         uses: actions/setup-node@v4
-      - name: Install packages
+      - name: Install Packages
         run: npm ci
         working-directory: website
-      - name: Build project
+      - name: Run Formatting Check
         run: npx prettier -c .
         working-directory: website