Skip to content

Commit fd468e4

Browse files
authored
Enhance updateJson.yml with comments for clarity
Added comments to clarify environment variables and job purposes.
1 parent 2e7c3b6 commit fd468e4

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

.github/workflows/updateJson.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# This workflow automatically updates key metadata about this repository used by the build-and-deploy action workflow
12
name: Update json file
23

34

@@ -14,11 +15,11 @@ permissions:
1415
env:
1516
GH_PAT: ${{ secrets.GH_STUDENT_PROJECT_REPO_PAT }} # Personal Access Token for cross-repo deployments
1617
EXT_REPO: ${{ vars.STUDENT_PROJECTS_REPO }} # External repository for deployment
17-
PROJECT_PATH: ${{ vars.PROJECT_PATH }}
18-
TEAM_NAME: ${{ vars.TEAM_NAME }}
18+
PROJECT_PATH: ${{ vars.PROJECT_PATH }} # The relative path of the Unity project to be built/deployed
19+
TEAM_NAME: ${{ vars.TEAM_NAME }} # The team name used to properly target destination folder and label(s) in deployment detination
1920

2021
jobs:
21-
update_metadata_here:
22+
update_metadata_here: # This job acts on this repository
2223
name: Update the release values for this project's JSON file entry
2324
runs-on: ubuntu-latest
2425

@@ -162,7 +163,7 @@ jobs:
162163
git commit -m "Update JSON metadata for ${TEAM_NAME}" || echo "No changes to commit."
163164
git push origin ${GITHUB_REF} || echo "No changes to push."
164165
165-
update_metadata_there:
166+
update_metadata_there: # This job acts on the external repository (destination where pages site is)
166167
name: Update JSON Entry in External Repository
167168
runs-on: ubuntu-latest
168169
needs: update_metadata_here

0 commit comments

Comments
 (0)