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

Adding a Github workflow for testimony validation #282

Merged
merged 2 commits into from
Jan 31, 2025

Conversation

zpetrace
Copy link
Contributor

@zpetrace zpetrace commented Aug 30, 2024

After more discussion this is a PR for testimony workflow only and should be merged after all the classes have the docstrings added.

Card ID: CCT-1152

@zpetrace zpetrace requested a review from ptoscano August 30, 2024 10:26
@zpetrace zpetrace changed the title Adding a Github workflow fo testimony validation Adding a Github workflow for testimony validation Aug 30, 2024
@zpetrace zpetrace force-pushed the zpetrace/testimony_workflow branch from 78e9e9d to 43ae8be Compare August 30, 2024 10:31
@zpetrace zpetrace force-pushed the zpetrace/testimony_workflow branch 2 times, most recently from 8c1743a to 8a2e32c Compare September 3, 2024 09:29
@ptoscano ptoscano force-pushed the zpetrace/testimony_workflow branch from 8a2e32c to a5706ca Compare October 3, 2024 15:14
@zpetrace zpetrace force-pushed the zpetrace/testimony_workflow branch from a5706ca to c25e5d2 Compare October 10, 2024 19:46
@zpetrace
Copy link
Contributor Author

After the last commit the testimony should be set to expect tags instead of tiers.

@ptoscano ptoscano force-pushed the zpetrace/testimony_workflow branch from c25e5d2 to 0d318d1 Compare October 17, 2024 13:39
@zpetrace zpetrace force-pushed the zpetrace/testimony_workflow branch 2 times, most recently from 2fa461f to eeb159c Compare January 6, 2025 14:13
@zpetrace zpetrace force-pushed the zpetrace/testimony_workflow branch from eeb159c to 000eb71 Compare January 31, 2025 13:39
@zpetrace zpetrace requested a review from pkoprda January 31, 2025 13:40
@zpetrace
Copy link
Contributor Author

I have discovered, that the :reference: field cannot be left blank, so if the test doesn't have a reference, the field cannot be included and left blank - now the checks are passing, therefore opening this PR for a review:)

@zpetrace zpetrace marked this pull request as ready for review January 31, 2025 13:41
@zpetrace zpetrace force-pushed the zpetrace/testimony_workflow branch 2 times, most recently from 93656ef to 5cfb130 Compare January 31, 2025 13:45
@ptoscano
Copy link
Contributor

I have discovered, that the :reference: field cannot be left blank, so if the test doesn't have a reference, the field cannot be included and left blank - now the checks are passing, therefore opening this PR for a review:)

Yay! Not to push for more work: would it be possible to split the fixes to the docstrings in its own commit (even in this PR, I think it should be fine)? This way it should be easier to document, to review, and to navigate the git history about those changes.

Thanks!

I have removed the :reference: fields that were left blank in the docstrings as they were causing the Testimony validate to fail. The empty fields were removed and the checks are now passing with this change.
I have added the workflow and spec file for the Testimony tool to work properly for our intagration-tests, it will now validate for every new PR made to integration-tests that all of the tests have a corect docstrings filled and none required field is missing. This is also a part of CCT-1152
@zpetrace zpetrace force-pushed the zpetrace/testimony_workflow branch from 5cfb130 to 9bb1c1f Compare January 31, 2025 14:01
@zpetrace
Copy link
Contributor Author

Done, now it looks definitely more readable:)

Copy link
Contributor

@ptoscano ptoscano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@ptoscano ptoscano merged commit d215935 into master Jan 31, 2025
13 of 14 checks passed
@ptoscano ptoscano deleted the zpetrace/testimony_workflow branch January 31, 2025 14:17
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.

2 participants