3  Changelog

Since we follow Conventional Commits we’re able to automatically create formal “releases” of the workshop based on our commit messages. Releases in the context of workshops are simply snapshots in time of the workshop content. The releases are published to Zenodo for easier discovery, archival, and citation purposes. We use Commitizen to automatically create these releases using SemVer as the version numbering scheme.

Because releases are created based on commit messages, a new release can be created quite often—sometimes several times in a day. This also means that any individual release will not have many changes within it. Below is a list of the releases we’ve made so far, along with what was changed within each release.

If you attended a workshop or used the workshop material as some point in time, you can always refer to this changelog page to find out what has been changed since you last used it.

3.1 0.5.0 (2026-02-07)

3.1.1 Feat

  • add lychee URL checking to justfile
  • exclude latex output files from typos

3.1.2 Refactor

  • ♻️ simplify code of conduct text

3.2 0.4.15 (2025-09-17)

3.2.1 Refactor

  • 📝 explain how releases work in CHANGELOG (#27)

3.3 0.4.14 (2025-09-08)

3.3.1 Fix

  • ✏️ can use svg in License badge
  • 🔧 need to include theme: brand in _quarto.yml
  • ✏️ remove duplicate sentence in pre-workshop overview

3.3.2 Refactor

  • 🎨 strip empty Jinja lines correctly

3.4 0.4.13 (2025-09-03)

3.4.1 Fix

  • 🐛 move github_repo as question to fix update issue

3.4.2 Refactor

  • ♻️ output get-contributors.sh as text, send to file in justfile

3.5 0.4.12 (2025-09-03)

3.5.1 Refactor

  • ♻️ minor text edits to pre-workshop code of conduct (#26)

3.6 0.4.11 (2025-09-03)

3.6.1 Fix

  • 🐛 dst_path isn’t good to use when running updates

3.7 0.4.10 (2025-09-03)

3.7.1 Refactor

  • 🚚 save _contributors.yml to includes/

3.8 0.4.9 (2025-09-03)

3.8.1 Refactor

  • ✏️ minor text edit to improve flow (#24)

3.9 0.4.8 (2025-09-03)

3.9.1 Fix

  • 🐛 correctly strip empty jinja lines

3.9.2 Refactor

  • ✏️ should be isIdenticalTo and lesson in .zenodo.json

3.10 0.4.7 (2025-09-03)

3.10.1 Refactor

  • ♻️ minor rewrite of star-us (#23)

3.11 0.4.6 (2025-09-03)

3.11.1 Refactor

  • ♻️ minor rewrites in learning design (#22)

3.12 0.4.5 (2025-09-02)

3.12.1 Fix

  • 🐛 need to check for existence of github_repo first

3.13 0.4.4 (2025-09-02)

3.13.1 Fix

  • ✏️ this badge is default svg, don’t end with it

3.14 0.4.3 (2025-09-02)

3.14.1 Refactor

  • 🔧 include revert as a branch tag
  • 🔨 ignore irrelevant dirs when listing TODOs
  • ✏️ remove trailing / from URL

3.15 0.4.2 (2025-09-02)

3.15.1 Fix

  • ✏️ no spaces around em-dashes

3.15.2 Refactor

  • 📝 simplify some text of the README
  • ♻️ replace ending of _contributors.yml with newline for pre-commit styling
  • 🔨 exclude justfile when listing TODOs
  • 🔨 use quarto update to match recipe name
  • ⬆️ update pre-commit hook versions

3.16 0.4.1 (2025-08-29)

3.16.1 Fix

  • ✏️ should say “teach”, not “instruct”
  • 🔥 removed left over note in justfile
  • ✏️ CONTRIBUTING in template shouldn’t refer to “template”

3.16.2 Refactor

  • 💄 use less emojis and a specific star in star-us includes
  • ♻️ mention that some files are for development too

3.17 0.4.0 (2025-08-29)

3.17.1 Feat

  • add GoatCounter HTML script

3.17.2 Refactor

  • 💄 strip empty Jinja lines
  • 🚚 Rproj file should only be added for R workshops

3.18 0.3.2 (2025-08-29)

3.18.1 Refactor

  • 💄 wrap text in README in a callout block for separation

3.19 0.3.1 (2025-08-28)

3.19.1 Fix

  • ✏️ forgot to include commas in .zenodo.json fields
  • ✏️ should be >- for validating
  • ✏️ should be knitr in the Rproj file, not Sweave

3.19.2 Refactor

  • 🔥 abbrev meta isn’t used anywhere

3.20 0.3.0 (2025-08-28)

3.20.1 Feat

  • 🔧 include changelog in website, plus add more text in it

3.20.2 Fix

  • 🔨 point contributor script to generated template repo
  • 🐛 need to store github_repo in answers file

3.20.3 Refactor

  • ♻️ add TODO item in slides
  • ✏️ use shorter link to LICENSE in README
  • 🔨 build contributor list in justfile, not Quarto config
  • 💄 use svg for copier badge
  • 🔥 keep assignee empty in Dependabot PRs

3.21 0.2.0 (2025-08-24)

3.21.1 Feat

  • 🔧 add all pages to _quarto.yml
  • add a “is this for you” page
  • create Jinja templated version of the landing page
  • include a survey includes file
  • output README.qmd to GFM Markdown version
  • create starting URL for workshop on copy
  • add (empty) CODEOWNERS
  • add author name questions
  • add empty objectives includes file
  • add a post-copy message and tasks

3.21.2 Fix

  • 🐛 actually have to insert _metadata.yml file in _quarto.yml
  • 🐛 include shortcode should always use root /
  • 🐛 Jinja strip empty lines needs a specific format
  • 🐛 Quarto {# need to be escaped in Jinja
  • 🐛 need to escape Quarto shortcodes if in Jinja file
  • ✏️ includes of file should have _
  • 🐛 Jinja else if needs to be elif
  • 🐛 can’t have spaces between %}

3.21.3 Refactor

  • ♻️ don’t update template in run-all of justfile
  • 🚚 includes need to be prefixed with _
  • 🔥 clean up leftover vscode setting files
  • ♻️ make intro slides a bit more generic
  • ♻️ include snippets of all possible sections in session
  • 🚚 rename to _star-us.qmd, not “follow”
  • 🚚 prefix includes with _
  • ♻️ stylistic and editing changes to installing R packages page
  • 🔥 remove duplicate text in survey page
  • ♻️ check that board number is a number
  • ♻️ switch to using bash in check-commits justfile
  • 📝 fix link to instructor guide
  • 🔥 don’t need the update from template workflow
  • ♻️ switch to using github_user and github_repo for project naming
  • ♻️ use lowercase for workshop type naming
  • ♻️ set Zenodo upload type to lesson
  • ♻️ moved version information for installing into _metadata.yml
  • ♻️ match syllabus structure to that done in GitHub Intro
  • 🔥 session isn’t always an R workshop, don’t need code chunk

3.22 0.1.0 (2025-08-24)

3.22.1 Feat

  • add initial, though empty, CHANGELOG file
  • fill out templating in _quarto.yml file
  • add _metadata.yml file to hold common text
  • 🔨 justfile recipe to build readme in template
  • update template’s README
  • set of default badges for template README and landing page
  • standalone page for learning design
  • add includes for “follow us” block
  • add justfile to template
  • add .zenodo.json to the template

3.22.2 Fix

  • 🐛 wrap ${{ }} in {{ to escape them
  • 🐛 should be { }, without the %

3.22.3 Refactor

  • 🔥 no need for generic “installing-programs” doc
  • ♻️ include “reading-website” into overview page
  • 🚚 simplify includes to all be in includes/
  • 🚚 converted includes into own pages in template
  • ♻️ remove social time from schedule
  • ♻️ include a starting URL for Quarto website in Netlify
  • 👷 merge template website build workflow into one file
  • ♻️ expand on template’s CONTRIBUTING doc
  • 🚚 move code of conduct out of includes as own page
  • ♻️ use only one .cz.toml, but use internal ‘if’ statements inside