Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add check_xml_unique Github Action #33

Closed
nusbaume opened this issue Apr 11, 2023 · 0 comments · Fixed by #34
Closed

Add check_xml_unique Github Action #33

nusbaume opened this issue Apr 11, 2023 · 0 comments · Fixed by #34
Assignees
Labels
enhancement New feature or request

Comments

@nusbaume
Copy link
Collaborator

The check_xml_unique.py tool can notify a developer when duplicate standard names exist in the dictionary, which is good to avoid since having duplicate standard names introduces an ambiguity which could then cause problems downstream (for example when the CCPP framework tries to generate interface codes).

However, there is no guarantee that a developer will run this tool before pushing changes to the standard names dictionary, which means a duplicate standard name could sneak in on accident. To avoid this problem, a Github Action workflow should be created that runs check_xml_unique.py on the dictionary file (standard_names.xml) whenever a Pull Request is opened or updated in this repo, which then should "fail" whenever a duplicate name is found.

Finally, along with the duplicate name check itself, the check_xml_unique.py should also run validate_xml_file similar to write_standard_name_table.py in order to ensure xmllint is always run on the dictionary file as well (to avoid any basic syntax errors).

@nusbaume nusbaume added the enhancement New feature or request label Apr 11, 2023
@nusbaume nusbaume self-assigned this Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant