Adds CITATION.cff && validation action - Githubissues

delb-xml / delb-py

A library that provides an ergonomic model for XML encoded text documents (e.g. with TEI-XML).

https://delb.readthedocs.io

GNU Affero General Public License v3.0

16 stars 0 forks source link

Adds CITATION.cff && validation action #34

Closed JKatzwinkel closed 2 years ago

JKatzwinkel commented 2 years ago

maybe we should leave this unmerged until release, as a reminder that we should not forget to add the date-released field with the release date.

funkyfuture commented 2 years ago

i'm postpoing this to 0.4. because:

the repository's URL will change
we'll setup a GH workflow for releases (#35) that will generate this file
- let's use this PR for the citation file generation in it
- i've seen a reasonable jinja action around

funkyfuture commented 2 years ago

two+ thoughts:

the rendered file should be included in the Python package
instead of including this in the release workflow directly, it could be a seperate workflow that will then be included
- though i don't know yet where else it would be used
- i'm not sure whether the validation step should be part of the quality-checks workflow

JKatzwinkel commented 2 years ago

should we render the citation file in the release make target then?

funkyfuture commented 2 years ago

now after some time working on an automated release workflow, i'm sceptical the effort would be worth it here. also, there's the problem that the tag should be created after the file has been generated. perspectively there will also be the generated xpath parser module. this one would have to be generated before running tests on every platform.

henceforth we should rely on scripts for these jobs. i propose that you move the generation logic to such a script, add a git hook that calls it and move the verification to the quality checks workflow (i wouldn't do this locally).

is there a more or less canonical name for paths with such scripts that is descriptive?

JKatzwinkel commented 2 years ago

I usually put stuff like that into build/ or bin/.

funkyfuture commented 2 years ago

i was already into setting up something with pre-commit, but realised that the two generation processes are quiet different.

should we render the citation file in the release make target then?

is the question that answers my question when is the proper time to set the file's contens.

https://pypi.org/project/jinja-cli/ looks feasible for the poetry dev environment. also, the validation therefore needs to happen locally. https://github.com/citation-file-format/cff-converter-python has a --validate flag that acts as subcommand.

funkyfuture commented 2 years ago

i'd move the templates folder to the root.

funkyfuture commented 2 years ago

i have this branch rebased onto main and added another render approach with just. i'm afraid force-pushing it will make previous comments less accessible. shall i wait until you settled the contents?