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

Directly compare raw XML files in CI #6

Open
2 tasks
parzhitsky opened this issue Oct 5, 2021 · 0 comments
Open
2 tasks

Directly compare raw XML files in CI #6

parzhitsky opened this issue Oct 5, 2021 · 0 comments
Labels
Change: patch [Issue / PR] describes a small non-breaking change, such as bugfix or an optimization Domain: meta [Issue / PR] describes change in the development process, documentation, maintenance etc. good first issue [Issue] can be addressed by a first-time contributor Priority: medium [Issue / PR] should be addressed without delay Type: bug [Issue / PR] addresses malfunction

Comments

@parzhitsky
Copy link
Member

parzhitsky commented Oct 5, 2021

Currently, to figure out whether the update is needed, there is a comparison between the currently published data.json file and a data.json file that would be built out of the latest XML file:

https://github.com/parzh/iso4217/blob/main/.github/workflows/publish-xml-updates.yml#L50-L58

Not only this introduces an unnecessary step of converting XML to JSON, but it also is prone to false positives in case if the potential new data.json file is in any way different (even if the change doesn't originate from the original data, – see #2):

{
  "$name": "SomeName",
  "$attr": {},
- "$data": 42
+ "$data": 42,
+ "$text": "42"
}
  • Distrubite the original XML along with the converted JSON as data.xml;
  • In CI, compare distributed data.xml with the XML content on maintainers' site;
@parzhitsky parzhitsky added Change: patch [Issue / PR] describes a small non-breaking change, such as bugfix or an optimization Domain: meta [Issue / PR] describes change in the development process, documentation, maintenance etc. Priority: medium [Issue / PR] should be addressed without delay Type: bug [Issue / PR] addresses malfunction good first issue [Issue] can be addressed by a first-time contributor labels Oct 5, 2021
@parzhitsky parzhitsky added Pending: unclear [Issue] not yet fully defined and removed Pending: unclear [Issue] not yet fully defined labels Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Change: patch [Issue / PR] describes a small non-breaking change, such as bugfix or an optimization Domain: meta [Issue / PR] describes change in the development process, documentation, maintenance etc. good first issue [Issue] can be addressed by a first-time contributor Priority: medium [Issue / PR] should be addressed without delay Type: bug [Issue / PR] addresses malfunction
Projects
None yet
Development

No branches or pull requests

1 participant