JabRef / abbrv.jabref.org

A repository of abbreviations for references, e.g., for conferences, journals, institutes, etc.
https://abbrv.jabref.org
Creative Commons Zero v1.0 Universal
141 stars 80 forks source link

Added Un-escaped Ampersands Checker for #107 #108

Closed AkshatJain9 closed 2 years ago

AkshatJain9 commented 2 years ago

I am currently working on #8948 in the main JabRef repository. As a part of that issue, we need to check that all Ampersands stored in each csv is un-escaped. This PR contains a simple Python Script which checks each CSV for this condition, throwing a value error if we find an escaped ampersand. The script is configured to run each time there is a push to the main branch using GitHub actions, and integrates well with the existing format/lint checkers. I am seeking some feedback on whether or not this integrates well with the existing workflow, as well as general code conventions and quality. There are also some minor formatting changes as the existing GitHub Actions job was failing.

Thanks in advance!

Siedlerchr commented 2 years ago

Thanks for the contribution! That already looks good to me

AkshatJain9 commented 2 years ago

Before (if) this is merged, could I be put as the assignee of the relevant issue? I am contributing as a part of a University Assignment so it would help me a lot admin-wise to show my marker. Thanks!

AkshatJain9 commented 2 years ago

How does that look? I've separated the jobs and fixed the CHANGELOG as required. The only small optimisation I can think of is to perhaps abstract the repeated Checkout source code into its own function using GitHub Composite Actions, but at this stage it seems like it will bloat the file more than it will simplify it, since its such a small Actions workflow. Let me know what you think!

AkshatJain9 commented 2 years ago

I hope I've fixed it now, let me know if any1 thing else is needed

koppor commented 2 years ago

I fixed the changelog issues for myself at 46856e1 (#108).

Thank you for working on this, I will merge.

AkshatJain9 commented 2 years ago

Thank you!