Fail if repo slug invalid, update readme

Author: froggleston

.github/workflows/website.yml

@@ -79,7 +79,6 @@ jobs:
           writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
         shell: Rscript {0}
 
-
       - name: Install system dependencies for R packages
         if: steps.check-rmd.outputs.count != 0
         run: |
@@ -98,6 +97,12 @@ jobs:
           ref: gh-pages
           path: gh-pages
 
+      - name: Validate workshop website
+        # https://github.com/carpentries/styles/issues/551 is no longer relevant as styles shouldn't be used for
+        # lessons but only workshop templates. So, always run the workshop checks now.
+        run: make workshop-check
+        if: always()
+
       - name: Commit and Push
         if: ${{ github.event_name == 'push' && steps.check-rmd.outputs.count != 0 && github.ref != 'refs/heads/gh-pages'}}
         run: |
@@ -118,8 +123,3 @@ jobs:
           git push origin gh-pages
           # return
           cd ..
-
-      # waiting for https://github.com/carpentries/styles/issues/551
-      # to be addressed
-      # - run: make lesson-check-all
-      #   if: always()

README.md

@@ -50,12 +50,13 @@ create a workshop website.
 3.  Select the owner for your new repository.
     (This will probably be you, but may instead be an organization you belong to.)
 
-4.  Create a slug for your workshop website repository.
+4.  Name your workshop website repository using the Carpentries slug format.
     The slug should have the form `YYYY-MM-DD-site`,
     e.g., `2016-12-01-oomza`,
     where `YYYY-MM-DD` is the start date of the workshop and 'oomza' is an example site name.
     If your workshop is held online, then the respository name should have `-online` in the end.
-    e.g., `2016-12-01-oomza-online`
+    e.g., `2016-12-01-oomza-online`. Your website build will fail if the name of your
+    repository does not match the valid slug format!
 
 5.  Make sure the repository is public, leave "Include all branches" unchecked, and click
 on "Create repository from template".

bin/workshop_check.py

@@ -401,27 +401,28 @@ def check_config(reporter, filename):
                    carpentry)
 
 
-def check_slug(reporter, repo_dir):
+def check_slug(reporter, filename, repo_dir):
     config = load_yaml(filename)
 
-    repo_name = os.path.basename(repo_dir)
+    repo_name = os.path.basename(os.path.realpath(repo_dir))
 
     carpentry = config.get('carpentry', None)
-    kind = config.get('kind', None)
-
-    if carpentry == "cp":
-        slugfmt = "YYYY-MM-DD-ttt-format"
-    else:
-        slugfmt = "YYYY-MM-DD-site-format"
-
-    fail_msg = f'Workshop website slug does not match the required `{slugfmt}`'
 
     if carpentry in ('swc', 'dc', 'lc', 'cp'):
-        reporter.check(
-            bool(re.match(SLUG_PATTERN, repo_name)),
-            fail_msg
+        if carpentry == "cp":
+            slugfmt = "YYYY-MM-DD-ttt[-online]"
+        else:
+            slugfmt = "YYYY-MM-DD-site[-online]"
+
+        fail_msg = (
+            'Website repository name `{0}` does not match the required slug format: `{1}`. '
+            'Please rename your repository to a valid slug using the rename option in the "Settings" menu.'
         )
 
+        if not bool(re.match(SLUG_PATTERN, repo_name)):
+            print(fail_msg.format(repo_name, slugfmt))
+            sys.exit(1)
+
 
 def main():
     '''Run as the main program.'''
@@ -436,7 +437,9 @@ def main():
 
     reporter = Reporter()
     check_config(reporter, config_file)
-    check_slug(reporter, root_dir)
+
+    check_slug(reporter, config_file, root_dir)
+
     check_unwanted_files(root_dir, reporter)
     with open(index_file, encoding='utf-8') as reader:
         data = reader.read()