markdown source builds

Auto-generated via `{sandpaper}`
Source  : 6121b43
Branch  : main
Author  : Robert Davey <robertdavey@carpentries.org>
Time    : 2024-12-03 10:36:47 +0000
Message : Merge pull request #218 from carpentries/tobyhodges-patch-2

Add instructions for configuring SANDPAPER_WORKFLOW post-transition

Author: actions-user

config.yaml

@@ -0,0 +1,92 @@
+#------------------------------------------------------------
+# Values for this lesson.
+#------------------------------------------------------------
+
+# Which carpentry is this (swc, dc, lc, or cp)?
+# swc: Software Carpentry
+# dc: Data Carpentry
+# lc: Library Carpentry
+# cp: Carpentries (to use for instructor traning for instance)
+carpentry: 'cp'
+
+# Overall title for pages.
+title: 'Introduction to The Carpentries Workbench'
+
+# Date the lesson was created (this is empty by default)
+created: ~
+
+# Comma-separated list of keywords for the lesson
+keywords: 'static site, lesson template, markdown, R, software'
+
+# Life cycle stage of the lesson
+# possible values: pre-alpha, alpha, beta, stable
+life_cycle: 'beta'
+
+# License of the lesson
+license: 'CC-BY 4.0'
+
+# Link to the source repository for this lesson
+source: 'https://github.com/carpentries/sandpaper-docs/'
+
+# Default branch of your lesson
+branch: 'main'
+
+# Who to contact if there are any issues
+contact: 'tobyhodges@carpentries.org'
+
+# Navigation ------------------------------------------------
+#
+# Use the following menu items to specify the order of
+# individual pages in each dropdown section. Leave blank to
+# include all pages in the folder.
+#
+# Example -------------
+#
+# episodes:
+# - introduction.md
+# - first-steps.md
+#
+# learners:
+# - setup.md
+#
+# instructors:
+# - instructor-notes.md
+#
+# profiles:
+# - one-learner.md
+# - another-learner.md
+
+# Order of episodes in your lesson
+episodes:
+- introduction.md
+- episodes.Rmd
+- editing.md
+- example.Rmd
+- deployment.md
+- update.md
+- pull-request.md
+
+# Information for Learners
+learners:
+- reference.md
+- setup.md
+- github-pat.md
+- component-guide.md
+- migrating-from-styles.md
+- style.md
+
+# Information for Instructors
+instructors:
+- instructor-notes.md
+
+# Learner Profiles
+profiles:
+- maintainer.md
+- instructor.md
+
+# Customisation ---------------------------------------------
+#
+# This space below is where custom yaml items (e.g. pinning
+# sandpaper and varnish versions) should live
+
+

md5sum.txt

@@ -16,7 +16,7 @@
 "learners/setup.md" "61754cdfdaa08ff73f388fea6c5c9522" "site/built/setup.md" "2024-12-03"
 "learners/github-pat.md" "65a2c6f46233a1335a6fc0392cb8a405" "site/built/github-pat.md" "2024-12-03"
 "learners/component-guide.md" "77bc5292747a4d06561e1e27861585cc" "site/built/component-guide.md" "2024-12-03"
-"learners/migrating-from-styles.md" "68dd61e4d88734fbf0ce9d3237080ebc" "site/built/migrating-from-styles.md" "2024-12-03"
+"learners/migrating-from-styles.md" "d754b5c0b53823ade2b7a7e5eb4f20a9" "site/built/migrating-from-styles.md" "2024-12-03"
 "learners/style.md" "59a4d847201ced45d9b78b8ec9b05993" "site/built/style.md" "2024-12-03"
 "profiles/maintainer.md" "2a2b790c0aa8da5fb72e323e4fafabd9" "site/built/maintainer.md" "2024-12-03"
 "profiles/instructor.md" "ff8c586028a5e1c7ef0be4178b40417c" "site/built/instructor.md" "2024-12-03"

migrating-from-styles.md

@@ -84,6 +84,13 @@ The script is run on the version of the Workbench lesson created by the transiti
 
 It is sufficient to create an empty file, named appropriately. This is available in the add-lesson.sh file, which will also provide hints about how the data can be transformed. 
 
+::::::::::::::::::::::::::::::::::::::: caution
+
+It is essential that you do not include a trailing `/` after YOUR-LESSON-NAME below.)
+
+:::::::::::::::::::::::::::::::::::::::::::::::
+
+
 ```bash
 bash add-lesson.sh carpentries-incubator/YOUR-LESSON-NAME
 ```
@@ -215,7 +222,19 @@ After you have transitioned your lesson, you should:
 
 1. **Delete and re-create any forks and local clones** of your lesson project, to minimise the likelihood that you will accidentally push the old project history back to the GitHub repository. If you have any collaborators and fellow lesson developers/maintainers, ask them to do the same.
 2. If your lesson is in The Carpentries Incubator, [**tell the Curriculum Team**](mailto:curriculum@carpentries.org) that you have completed the transition so that we can activate the automated creation of pull requests to update the Workbench infrastructure when new versions of the packages are released.
-3. (Optional, but highly recommended) Open a pull request to https://github.com/carpentries/reactables/ to **add the invalid commit hash** (in the `invalid.hash` file created for your lesson during the transition (step 3 above)) to [the `workbench/invalid-hashes.json` file](https://github.com/carpentries/reactables/blob/main/workbench/invalid-hashes.json). This will include the hash in the data feed used by our infrastructure to support the GitHub Actions workflow that will automatically close any pull requests opened to your repository from a branch containing the old project history. To do this:
+3. If your lesson is _not_ in the Incubator, **enable automated pull requests to keep your infrastructure updated** by adding a SANDPAPER_WORKFLOW token to your repository:
+    * Navigate to <https://github.com/settings/tokens/new> and give your new token a name (e.g. "Sandpaper Token (YOUR-ORG-OR-USER-NAME/YOUR-LESSON-NAME)").
+    * Check the box next to _workflow_.
+    * Set an expiry date for the token.
+    * Select _Generate token_.
+    * Copy the token displayed on the screen.
+    * On your GitHub repository:
+        * Navigate to Settings->Secrets and variables->Actions->New repository secret
+        * Set _Name_ to SANDPAPER_WORKFLOW, and paste your new token into the _Secret_ box.
+        * Select Add secret
+  
+  The maintenance workflows that use this token are scheduled to run weekly. When The Carpentries releases new versions of the workflow files used to build and maintain lessons, a pull request will be opened automatically on any repository with the SANDPAPER_WORKFLOW token set to incorporate the relevant updates. If your lesson uses R Markdown source files, the same token will be used to keep the package dependencies for your lesson updated.
+5. (Optional, but highly recommended) Open a pull request to https://github.com/carpentries/reactables/ to **add the invalid commit hash** (in the `invalid.hash` file created for your lesson during the transition (step 3 above)) to [the `workbench/invalid-hashes.json` file](https://github.com/carpentries/reactables/blob/main/workbench/invalid-hashes.json). This will include the hash in the data feed used by our infrastructure to support the GitHub Actions workflow that will automatically close any pull requests opened to your repository from a branch containing the old project history. To do this:
     * Make a fork of [the `carpentries/reactables` GitHub repository](https://github.com/carpentries/reactables/)
     * On a new branch of that fork, edit the `workbench/invalid-hashes.json` file, adding a new line before the final `}` line matching the format of the other lines containing hashes, i.e. 
       `"carpentries-incubator/YOUR-LESSON-NAME": "HASHASHASHASHASHASHASH"`