.github: fix frontpage README overridden by .github/README.md#20168
Closed
.github: fix frontpage README overridden by .github/README.md#20168
Conversation
GitHub renders .github/README.md in preference to the root README.md, so the repository front page was showing CI guidelines instead of the project overview. Combine .github/README.md and .github/PROPOSAL.md into CI-GUIDELINES.md at the repo root and update references.
Replace the trigger ladder with four explicit buckets (pull request, merge queue, push to main/release, scheduled), each with a clear contract. Add guidance on flaky test placement, cache-warming-only push runs, and scheduled failure attribution.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
GitHub renders
.github/README.mdin preference to the rootREADME.md, so the repository front page was showing CI guidelines instead of the Erigon project overview..github/README.mdand.github/PROPOSAL.mdCI-GUIDELINES.mdat the repo root, reorganised around four explicit trigger bucketsagents.md/CLAUDE.mdCI guidelines restructure
The guidelines are now organised around four buckets with explicit contracts:
pull_requestmerge_grouppushtomain/release/**scheduleCurrent state of CI and open problems
Flaky tests running on main and release branches
Several tests that fail intermittently are currently triggered on
mainand releasebranches. This causes two problems:
eroding confidence in the CI signal.
mainor a release branch cannot be corrected. Thereis no PR to fix, no author to notify, and no way to amend the commit. To outside
observers the branch simply looks broken.
The preferred remedy is to move flaky tests to the PR bucket, where failures are visible
to the author and can be prioritised. Failures on a PR are contained; failures on
mainare permanent and public.
Options on the table:
person at the right time, rather than polluting
main.before deciding on a result. This can absorb occasional flakiness but increases queue
latency and is not a long-term solution — it masks the problem rather than fixing it.
merge. However, this does not help with the
main/release branch problem: anon-blocking failure still shows up on the commit, still signals low-quality code to
outside observers, and still cannot be corrected.
Failure visibility and attribution
When a scheduled workflow fails, there is currently no reliable link between the failure
and the commit that introduced it. QA collects and reports on scheduled failures, but
addressing them is not a visible development priority because the failure does not appear
on the commit itself.
One proposal is to use an alternate GitHub token to retroactively post a commit status
or check run against the specific commit that first introduced the regression. This would
surface the failure at the point where it landed rather than at the point the scheduled
job happened to run, making it harder to defer.