Post-commit test task guides
These guides provide steps for common post-commit test failure tasks.
Finding someone to triage a post-commit test failure
To find the proper person to triage a test failure, you can use these suggestions:
- If you can triage it yourself, go for it.
- Look at the GitHub blame for the files with problematic code.
- Ask in the Beam Slack chat.
- Write to the dev list: firstname.lastname@example.org
Rolling back a commit
Rolling back is usually the fastest way to fix a failing test. However it is is often inconvenient for the original author. To help the author fix the issue, follow these steps when you rollback someone’s change.
- Rollback the PR (or individual commit of the PR). The rollback PR should be green except in rare cases.
- Create a GitHub issue that contains the following information:
- the reason for the rollback
- a link to the test failure’s GitHub issue
- triage information
- any other relevant details
- Assign the new GitHub issue to the original PR author.
- Consider re-opening the GitHub issue associated with the original PR (if there is one).
- Send a notification email with information about the rollback, links to the
original PR and the rollback PR, and the reasons for the rollback to:
- the original PR author and the committer of the PR
- Close the test failure GitHub issue. Your work is done here!
Disabling a failing test
If a test fails, our first priority is to rollback the problematic code and fix the issue. However, if both: rollback and fix will take awhile to implement, it is safer to temporarily disable the test until the fix is ready.
Use caution when deciding to disable a test. When tests are disabled, contributors are no longer developing on top of fully tested code. If you decide to disable a test, use the following guidelines:
- Notify the email@example.com mailing list. Describe the problem and let everyone know which test you are disabling.
- Implement the fix and get the test back online as soon as possible.
While the test is disabled, contributors should not push code to the failing test’s coverage area. The code area is not properly tested until you fix the test.
Last updated on 2023/03/30
Have you found everything you were looking for?
Was it all useful and clear? Is there anything that you would like to change? Let us know!