v1.3.0

[vincerubinetti]

Closes #272
Closes #269
Closes #191 (hopefully)

New template version checklist:

• I have updated CITATION and CHANGELOG as appropriate.
• I have updated lab-website-template-docs as appropriate. Pending change request: https://greene-lab.gitbook.io/lab-website-template-docs/~/changes/a57wjuxagDtJUR241kyt/basics/components/list
• I have checked the testbed as appropriate.

---

• use name field for all debug/logging steps in workflows
• use jwalton/gh-find-current-pr to get PR number to be more reliable (in rare cases, github.event.number can be empty)
• fix bug in "first time setup" workflow where description gets appended to user due to missing \n in printf
• rename workflows from .yml to .yaml for consistency
• remove useless "build preview" workflow run in "on schedule" †
• dont run "update citations" workflow on PR close, which should hopefully avoid issues discussed in Update citations fails on pull request close trigger #191. in my testing on a fork (vincerubinetti/lab-website-template), it does. need to use step-level if skipping instead of job-level or workflow-level because of this issue.
• when "on schedule" workflow opens a PR, add hint in body of the PR on how to trigger the live preview workflow
• use the xml_escape liquid filter wherever a user/third-party provided field is used in an HTML attribute to prevent special characters breaking HTML rendering. example: aria-label="{{ citation.title }}" and citation.title is "Lorem Ipsum" dataset, causing attribute to prematurely close.
• change data_filter to accept Ruby expressions instead of custom syntax. use Ruby eval and define each field in the item as a local variable, e.g. {"animal": "cat"} lets you use filter="animal == 'cat'".
• fix heading anchor styles
• add styles for <details> element
• fix logo shrinking/growing css bugs

† due to a github limitation, it wouldn't not run anyway on the auto-created PR. the user must close/reopen the PR, then the regular "on pr" workflow (which includes running "build preview") will run. i've already updated the docs to talk about this. from now on, let's treat auto-opening PR as the only supported way. previously i considered that the user could change open-pr to false to have "on schedule" commit updated citations directly to main, but let's nix that to maintain simplicity. it's probably better that we force the user to review the changes before pushing them to their live site anyway. if we did want to support that in the future, the "build preview" run i removed would have to be changed to a "build site", since we'd want to be re-building the main branch version of the site, not a preview for a PR.

[github-actions]

PR Preview Action v1.4.7
🚀 Deployed preview to https://greenelab.github.io/lab-website-template/preview/pr-274/
on branch gh-pages at 2024-10-28 16:30 UTC

[vincerubinetti]

Still want to test this out more, to make extra sure the list filter expressions and workflow changes are working, but reviewers can start taking a look.

[vincerubinetti]

@cgreene I think this review is going to fall on you, as it's more of a philosophical design change than a technical change, aside from the one section of code that supports the Ruby expression filtering which is a little weird.

I've also "annotated" the diff with comments that hopefully will make it easier to read.

[falquaddoomi]

Nice! Neat that you're using expressions for filters now. I left a few minor comments, but nothing that really needs to be addressed before merging.