Reflecting on our mistakes and how we can improve #375
AnonymousWP
announced in
Announcements
Replies: 2 comments 5 replies
-
Yaaay!Thank you for your hard work |
Beta Was this translation helpful? Give feedback.
0 replies
-
Hey. Thing to note:
This is just a proof of concept, that we can validate JSON file. |
Beta Was this translation helpful? Give feedback.
5 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
What happened?
As you may have experienced yesterday, UAD-ng suddenly stopped working when trying to fetch the JSON-list. This has happened a few times in the past as well, and both times the issue lied in the structure of the JSON-file. In this case, it was caused by a pull request of one of our core members that was probably partly outdated (and likely made before this refactoring PR). When I reviewed the PR, I precisely checked the recommendations, lists and descriptions, but haven't thought about this potential situation/problem. Because: who would expect this to happen at all? At the time it happened, I was AFK and some other team members discussed what could be causing this issue. Later, one of our team members created a PR that fixed this issue.
But, of course this shouldn't have happened and I do take the blame for this issue. Because then what else is the purpose of reviewing?
What are we going to do to prevent this from happening again?
We realised that we need some way to prevent this in the future as we had a few similar issues. We're now researching how we can prevent this, and the most logical one is to use a GitHub Action/workflow to verify whether the JSON-list's schema is still as how it should be. That way, we get warned and the GitHub Action will fail in case there's something wrong with the schema. We're checking if this is a possible solution.
We're also going to be more strict with branches, as the branch by our team member was old and probably re-used a couple of times, resulting in inconsistencies.
Small surprise to make it up
The release of version 1.0.3 is very nearby. We only have one issue to fix, which already has a PR that will close said issue. It brings a lot of bug-fixes and numerous quality-of-life improvements. 🙂
Beta Was this translation helpful? Give feedback.
All reactions