Customize Video URLs (#2)

* Customize video urls

* Pass repo secrets in production

* Customization instructions

Author: s2t2

.github/workflows/deploy.yml

@@ -50,6 +50,12 @@ jobs:
 
     # RENDER HTML AND PDF (see docs/_build)
     - name: Build the book
+      env:
+        # pass repo secrets as environment variables:
+        EXERCISE_1_VIDEO_URL: ${{ secrets.EXERCISE_1_VIDEO_URL }}
+        EXERCISE_2_VIDEO_URL: ${{ secrets.EXERCISE_2_VIDEO_URL }}
+        EXERCISE_3_VIDEO_URL: ${{ secrets.EXERCISE_3_VIDEO_URL }}
+        EXERCISE_4_VIDEO_URL: ${{ secrets.EXERCISE_4_VIDEO_URL }}
       run: |
         quarto render docs/
 

docs/README.md

@@ -31,6 +31,22 @@ Install package dependencies:
 pip install -r docs/requirements.txt
 ```
 
+
+## Customization
+
+We are using environment variables to customize video URLs across different copies of the repository.
+
+To set your own video URLs for local development, create a ".env" file in the "docs" folder, and place contents inside like the following:
+
+```sh
+# this is the docs/.env" file...
+
+EXERCISE_1_VIDEO_URL="https://vimeo.com/1078779616"
+EXERCISE_2_VIDEO_URL="https://vimeo.com/1078782830"
+EXERCISE_3_VIDEO_URL="https://vimeo.com/1078783956"
+EXERCISE_4_VIDEO_URL="https://vimeo.com/1078785045"
+```
+
 ## Initialization
 
 FYI the following command was used to initialize the quarto config:
@@ -66,3 +82,5 @@ quarto render docs/ --verbose
 We are using the ["deploy.yml" workflow configuration file](/.github/workflows/deploy.yml) to deploy the site to GitHub Pages when new commits are pushed to the main branch.
 
 In order for this to work, you first need to configure your GitHub Pages repo settings to publish via GitHub Actions.
+
+If you would like to customize environment variables, you will also need to set them as repository secrets using the repository settings. The GitHub Actions workflow file will read repository secrets and pass them to the build as environment variables (no ".env" file necessary in production).

docs/exercises/1-version-control-workflow/index.qmd

@@ -6,8 +6,22 @@ Gain familiarity with basic version control operations, including creating repos
 
 ## Walkthrough Video
 
-{{< video "https://vimeo.com/1078779616"
-    title= "Version Control Workflow - Exercise Walkthrough" >}}
+```{python}
+#| echo: false
+#| output: asis
+
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+
+VIDEO_URL = os.getenv("EXERCISE_1_VIDEO_URL", default="https://www.youtube.com/watch?v=UCcbvta2dp4")
+VIDEO_TITLE = "Version Control Workflow - Exercise Walkthrough"
+
+video_markdown = "{{< video " + f"'{VIDEO_URL}'" + f" title= '{VIDEO_TITLE}' " + " >}}"
+print(video_markdown)
+```
+
 
 ## Instructions
 

docs/exercises/2-pull-request-workflow/index.qmd

@@ -6,8 +6,22 @@ Adopt a Pull Request Workflow to collaborate with yourself (on independent proje
 
 ## Walkthrough Video
 
-{{< video "https://vimeo.com/1078782830"
-    title="Pull Request Workflow - Exercise Walkthrough" >}}
+```{python}
+#| echo: false
+#| output: asis
+
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+
+VIDEO_URL = os.getenv("EXERCISE_2_VIDEO_URL", default="https://www.youtube.com/watch?v=NTzUbULGc3o")
+VIDEO_TITLE = "Pull Request Workflow - Exercise Walkthrough"
+
+video_markdown = "{{< video " + f"'{VIDEO_URL}'" + f" title= '{VIDEO_TITLE}' " + " >}}"
+print(video_markdown)
+```
+
 
 ## Instructions
 

docs/exercises/3-developer-team-workflow/index.qmd

@@ -6,8 +6,22 @@ Adopt a Pull Request Workflow to collaborate with teammates, on team projects wh
 
 ## Walkthrough Video
 
-{{< video "https://vimeo.com/1078783956"
-    title= "Developer Team Workflow - Exercise Walkthrough" >}}
+```{python}
+#| echo: false
+#| output: asis
+
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+
+VIDEO_URL = os.getenv("EXERCISE_3_VIDEO_URL", default="https://www.youtube.com/watch?v=vsewcY7jwYA")
+VIDEO_TITLE = "Developer Team Workflow - Exercise Walkthrough"
+
+video_markdown = "{{< video " + f"'{VIDEO_URL}'" + f" title= '{VIDEO_TITLE}' " + " >}}"
+print(video_markdown)
+```
+
 
 > Thanks to [Reed Uhlik](https://www.reeduhlik.com/) for collaborating on this video.
 

docs/exercises/4-open-source-workflow/index.qmd

@@ -6,8 +6,23 @@ Adopt and practice a Pull Request Workflow to collaborate with people you don't
 
 ## Walkthrough Video
 
-{{< video "https://vimeo.com/1078785045"
-    title="Open Source Workflow - Exercise Walkthrough" >}}
+```{python}
+#| echo: false
+#| output: asis
+
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+
+VIDEO_URL = os.getenv("EXERCISE_4_VIDEO_URL", default="https://www.youtube.com/watch?v=X0UQAVwzBZE")
+VIDEO_TITLE = "Open Source Workflow - Exercise Walkthrough"
+
+video_markdown = "{{< video " + f"'{VIDEO_URL}'" + f" title= '{VIDEO_TITLE}' " + " >}}"
+print(video_markdown)
+```
+
+
 
 > Thanks to [Reed Uhlik](https://www.reeduhlik.com/) for collaborating on this video.
 

docs/requirements.txt

@@ -9,7 +9,7 @@ jupyter
 #jupyter-cache
 
 # reading environment variables from the .env file:
-#python-dotenv
+python-dotenv
 
 # packages required by any python code / notebooks:
 #numpy