Skip to content

Commit 9839c1d

Browse files
committed
Update the doc and add line to config.yml.
1 parent 22eef82 commit 9839c1d

2 files changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1-
This creates as CSV file to export to TeSS software, using the
1+
This creates a CSV file to export to TeSS software, using the
22
[youtube_to_csv](https://github.com/ualberta-rcg/youtube_to_csv) python code
3-
and a Github action (I hope).
3+
and a Github action.
4+
5+
The ingredients:
6+
7+
* The `config.yml` has the configuration for generating the CSV file. Specifically:
8+
* it has a URL to a Youtube RSS feed for our channel.
9+
* it has some some default metadata values for each videos
10+
* it also has some specific metadata values for each video (identified by title)
11+
* It has an action that then generates and commits the `youtube.csv` file on each commit.
12+
This action is `.github/workflows/generate_csv.yml`. The software that generates the CSV
13+
file is [youtube_to_csv](https://github.com/ualberta-rcg/youtube_to_csv), which the action
14+
checks out of Github and runs when a commit is pushed to `main` branch
15+
16+
The output: `youtube.csv`, which can be pointed at through a `Material CSV` source in TeSS.
17+
18+
TODO: maybe make the action smart enough that it only runs on changes to `config.yml`.

config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
url: https://www.youtube.com/feeds/videos.xml?channel_id=UCERhES8Kh7n29qtkoEl9MSQ
2+
23
defaults:
34
licence: CC-BY-NC-SA-4.0
45
status: active

0 commit comments

Comments
 (0)