Merge pull request #89 from htw-imi-showtime/semester-tools

Added script for scaffolding new semesters

README.md

@@ -7,17 +7,17 @@ The official IMI showtime website
 
 [Preview: https://htw-imi-showtime.github.io/](https://htw-imi-showtime.github.io/)
 
-- [IMI Showtime Website](#imi-showtime-website)
-  - [Adding a new project](#adding-a-new-project)
-  - [Updating your Fork](#updating-your-fork)
-  - [Including additional content](#including-additional-content)
-    - [Sections](#sections)
-    - [Images](#images)
-    - [Gallery](#gallery)
-      - [Special Case: Team Gallery](#special-case-team-gallery)
-    - [Videos](#videos)
-    - [HTW Mediathek Player](#htw-mediathek-player)
-    - [GitHub Gists](#github-gists)
+- [Adding a new project](#adding-a-new-project)
+- [Updating your Fork](#updating-your-fork)
+- [Including additional content](#including-additional-content)
+  - [Sections](#sections)
+  - [Images](#images)
+  - [Gallery](#gallery)
+    - [Special Case: Team Gallery](#special-case-team-gallery)
+  - [Videos](#videos)
+  - [HTW Mediathek Player](#htw-mediathek-player)
+  - [GitHub Gists](#github-gists)
+- [Adding a new semester](#adding-a-new-semester)
 
 ## Adding a new project
 If you want to add your project to the website, please follow these steps and create a pull request when you're done:
@@ -167,3 +167,15 @@ Example: Embedding https://gist.github.com/Kaes3kuch3n/643befb000375fea7c5f675fb
 ```handlebars
 {{<gist "Kaes3kuch3n" "643befb000375fea7c5f675fb180cfbd">}}
 ```
+
+## Adding a new semester
+This repository contains a utility script to transition the website to a new semester.
+It changes the semester set in the config file (`current_semester` in `config/_default/config.toml`) and 
+scaffolds the folder structure for the projects of the new semester.
+```shell
+./new_semester.sh <semester>
+```
+Example: Transitioning to winter semester 2021/22
+```shell
+./new_semester.sh ws21
+```

archetypes/semester/bachelor/_index.md

@@ -0,0 +1,7 @@
++++
+type = "{{ .Name }}"
+
+[cascade]
+    type = "Bachelor"
+    layout = "project"
++++

archetypes/semester/master/_index.md

@@ -0,0 +1,7 @@
++++
+type = "{{ .Name }}"
+
+[cascade]
+    type = "Master"
+    layout = "project"
++++

config/_default/config.toml

@@ -5,7 +5,6 @@ theme = "showtime-theme-2021"
 
 [params]
     current_semester = "ss21"
-    archive_semester = "ss20"
 
 [markup]
     [markup.goldmark]

new_semester.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+set -e
+
+if [ "$#" -ne 1 ]; then
+  echo "Usage: ./new_semester.sh <semester>"
+  echo "Replace <semester> with a semester abbreviation, e.g. 'ws21' for 'winter semester 2021'"
+  exit 1
+fi
+
+# Check if semester is valid
+(echo "$1" | grep -Eq "^(ws|ss)[0-9]{2}$") || (echo "Error: Invalid semester passed" && exit 2)
+
+# Update the semester set in the config file
+sed -e "s/ws[0-9]\{2\}/$1/;s/ss[0-9]\{2\}/$1/" -i "" config/_default/config.toml
+# Create a new project folder for this semester
+hugo new --kind semester $1