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

Fix/val-247 readme adjustments #177

Merged
merged 10 commits into from May 2, 2024
Merged

Conversation

Ghesselink
Copy link
Contributor

Add new up-to-date README files outputting the same data as in the frontend of the vs service (instance_id, expected, observed).
Additionally, a modified script to automatically generate this format is added.

Future to-do; the behave output conversion to tabulate/pytest is perhaps a bit outdated and could use a lick of paint.

@Ghesselink Ghesselink changed the title Fix/val 457 readme adjustments Fix/val-247 readme adjustments Apr 27, 2024
aothms
aothms previously requested changes Apr 30, 2024
test/generate_markdown.py Outdated Show resolved Hide resolved
test/generate_markdown.py Outdated Show resolved Hide resolved
Base automatically changed from development to main May 1, 2024 09:39
@Ghesselink
Copy link
Contributor Author

Added a couple of commits :

  • Update markdown generator. It's not always straightforward to get the output message (which is a string representation of ValidationOutcome) back to a dict in a generic way. I think it's working better now.
  • Add a script to create a readme file for all rules with one command (python test/run_generate_markdown.py)
  • Disabled the disabled rules from generating.
  • Run the previous mentioned script once to generate markdown README.md files

@Ghesselink Ghesselink dismissed aothms’s stale review May 2, 2024 08:32

Changes addressed

@Ghesselink Ghesselink merged commit 66b0e4e into main May 2, 2024
2 checks passed
@Ghesselink Ghesselink deleted the fix/val-457_readme_adjustments branch May 2, 2024 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants