v1.3.1

[vincerubinetti]

Closes #288
Closes #287
Closes #285

New template version checklist:

• I have updated CITATION and CHANGELOG as appropriate.
• I have updated lab-website-template-docs as appropriate.
• I have checked the testbed as appropriate.

---

• use latest major version of setup-ruby gh-action
• run "commit cache" step if citations step fails so that progress (successful citations) will be saved
• replace xml_escape filter with appropriate escapes for each situation, and slightly modify regex_strip filter to allow some basic punctuation

[github-actions]

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-11-13 22:56 UTC

[vincerubinetti]

Still testing the commit cache step on a personal repo. It doesn't seem to be detecting any change to the cache.

[vincerubinetti]

For now, I've just removed the /.cache ignoring from .gitignore. I've asked a question here: stefanzweifel/git-auto-commit-action#351

But the very first example block of code I give there is actually a lie. I've never seen the diskcache package I'm using create any file other than cache.db in that folder, so it's not really an issue. I originally put those lines in the gitignore just in case it did, to keep the repo clean. But realistically I've never seen it happen.

[falquaddoomi]

FWIW, the problem with your .gitignore is that you've ignored the .cache folder so Git doesn't process the !cache.db directive, since it's at the file level and the folder's already been ignored. You can read more about the behavior here: https://git-scm.com/docs/gitignore, specifically this part regarding the ! operator:

An optional prefix "!" which negates the pattern; any matching file excluded by a previous pattern will become included again. It is not possible to re-include a file if a parent directory of that file is excluded.

You can make the un-ignore more specific by specifying its parent folder with it, i.e. !.cache/cache.db, so that it becomes a path-level directive and can successfully override the ignore of .cache.

I think just omitting .cache from your gitignore is fine, since as you said you only ever see a file that you actually want included in there, but I thought you might be curious how to fix it for other cases.

EDIT: Well, never mind; after telling you that, I tested it and it didn't work. Changing .cache from a folder-level ignore to .cache/*, a file-level ignore, and then un-ignoring cache.db via !cache.db did work for me, though. So, in total, this should do what you want:

.cache/*
!cache.db

[falquaddoomi]

Makes sense to me; nice to see you using specific escape functions for specific cases, as that'll definitely be more robust and require less work when it's time to unescape it.