styles icon indicating copy to clipboard operation
styles copied to clipboard

create GH Actions to inset version number in footer of template?

Open fmichonneau opened this issue 4 years ago • 2 comments

The footer of the template includes "Using The Carpentries style version 9.5.3." (it has been the same version number for a long time...)

The version number is hard-coded, and we continuously bring improvements to the template, which is not very suitable for a release-based versioning system.

I'm wondering if we could use a GitHub Actions workflow to insert into the footer the (short) sha1 from the latest commit (or something else) to identify the version number. This could possibly be done with a variable (stored in _config.yml or _data/version.yml for instance).

One of the drawbacks is that it would create a lot of noise in the commit history.

fmichonneau avatar Aug 14 '20 09:08 fmichonneau

I'm wondering if we could use a GitHub Actions workflow to insert into the footer the (short) sha1 from the latest commit (or something else) to identify the version number. This could possibly be done with a variable (stored in _config.yml or _data/version.yml for instance).

We can definitely do that for lessons and it shouldn't create too much noise -- one extra PR when lessons sync up with this repo. We can create an action that would submit a pull request to update _includes/lesson_footer.html.

maxim-belkin avatar Aug 14 '20 20:08 maxim-belkin

Using _data/styles_version.yml might be a good idea too.

maxim-belkin avatar Aug 14 '20 21:08 maxim-belkin