COMCIFS / magnetic_dic

Development of the magnetic CIF dictionary
0 stars 4 forks source link

Add DDLm checks to GitHub actions #30

Open vaitkus opened 1 year ago

vaitkus commented 1 year ago

Currently, GitHub actions only check the syntax of the dictionary file, but not the style or semantics as in other dictionary repositories.

However, it was mentioned in a comment of a different issue [1] that there are some changes lined up, so I am not completely sure when would be the least disruptive time to turn on the checks. One the one hand they do detected some serious internal inconsistencies, but on the other hand they do complain about some trivial things like update dates, etc.

[1] https://github.com/COMCIFS/magnetic_dic/issues/29#issuecomment-1610278019

brantonc commented 1 year ago

Can GitHub Actions be selectively turned off again for the magCIF repository if it creates a hindrance to pending changes from the commission?

vaitkus commented 1 year ago

Yes, in that case we could simply disable the checks. Also, the general policy towards GitHub actions in other dictionary repositories is pretty lax -- even if the checks fail (i.e. issues are detected), this does not technically prevent the PRs from being merged.

vaitkus commented 1 year ago

I just realised that CIF_MAG imports CIF_MS (modulated structure) dictionary which is also currently not checked against the additional DDLm rules. We should probably fix that first.