chore(ci,docs): reconcile runbooks, add Pact Broker can-i-deploy gate, modernize CI - #1416
Open
Emeka000 wants to merge 1 commit into
Open
Conversation
…modernize CI SR-220: RUNBOOK.md was moved under docs/ earlier but check-alert-runbooks.js still read the old root path and crashed monitoring-ci. Point it (and the alert/slo runbook_url annotations + monitoring-ci path triggers) at docs/RUNBOOK.md. Add cross-link callouts to both runbooks — ROLLBACK_RUNBOOK.md is canonical for mainnet recovery, RUNBOOK.md is the general/testnet reference — and convert RUNBOOK.md's `soroban contract` commands to `stellar contract` so the two files are copy-paste compatible. SR-216: stand up a Pact Broker path, all gated on the PACT_BROKER_BASE_URL repo variable (inert until configured). Consumer jobs publish pacts to the broker (scripts/pact-publish.sh); provider verification pulls by consumer-version selector and publishes results keyed by the API SHA; deploy-staging.yml and deploy-mainnet.yml gain a can-i-deploy gate (scripts/pact-can-i-deploy.sh); the commit-pacts-to-main job only runs while no broker is configured. Self-hosted broker added to docker-compose.yml under a `pact-broker` profile. Docs in docs/PACT_BROKER.md. SR-211: openapi-validation.yml -> checkout@v4 + ./.github/actions/setup-node composite (Node 20, npm caching), replacing checkout@v3/setup-node@v3/node 18. SR-210: release.yml build-artifacts -> ./.github/actions/setup-rust with targets: wasm32-unknown-unknown, replacing the archived actions-rs/toolchain@v1. Also: deploy-staging.yml smoke-tests referenced needs.build-images without depending on it — added to needs. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
@chidinma000 is attempting to deploy a commit to the Harold's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
@Emeka000 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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.
Summary
Implements SR-220, SR-216, SR-211, and SR-210. All changes are backward-compatible: the Pact Broker integration is inert until a broker is configured, and the two CI-modernization changes are drop-in action/runtime bumps.
SR-220 — Reconcile
RUNBOOK.mdanddocs/ROLLBACK_RUNBOOK.mdinto one on-call procedureRUNBOOK.mdwas moved todocs/in an earlier docs-consolidation commit, but that move leftscripts/check-alert-runbooks.jscrashing on a missing rootRUNBOOK.md—monitoring-ciwas effectively broken.check-alert-runbooks.jsreadsdocs/RUNBOOK.md;monitoring/alerts.yml+monitoring/slo.ymlrunbook_urlannotations repointed todocs/RUNBOOK.md#…;monitoring-ci.ymlpath triggers updated.check-alert-runbooks.jsnow passes (27 alerts, all sections resolve).docs/ROLLBACK_RUNBOOK.mdis canonical for mainnet incident recovery (severity matrix, WASM rollback, state migration, authority matrix);docs/RUNBOOK.mdis the network-agnostic day-to-day reference and the "start here" doc.soroban contract …commands indocs/RUNBOOK.mdconverted tostellar contract …, so commands are copy-paste compatible between the two runbooks.README.md,docs/README.md,docs/PRODUCTION_READINESS_CHECKLIST.md; fixed a few pre-existing broken links in the runbook files while there.SR-216 — Pact Broker +
can-i-deploygateEverything is gated on the
PACT_BROKER_BASE_URLrepository variable — with it unset the pipeline behaves exactly as before (artifacts + commit-to-main), so this is safe to merge before the broker exists.pact-broker+ dedicated Postgres added todocker-compose.ymlunder apact-brokerprofile (docker compose --profile pact-broker up).scripts/pact-publish.sh; consumer jobs inpact-contract-tests.ymlpublish pacts to the broker (tagged by branch + commit SHA) alongside the existing artifact upload.provider-verification.pact.test.tsis now broker-aware — pulls pacts by consumer-version selector and publishes verification results keyed by the API commit SHA when a broker is configured; falls back to local pact files otherwise (unchanged behavior).scripts/pact-can-i-deploy.sh+ apact-can-i-deployjob indeploy-staging.yml(gatesdeploy) and agate-pactjob indeploy-mainnet.yml(betweenrequire-checklistandbuild-wasm).publish-pactsnow only runs while no broker is configured.docs/PACT_BROKER.mdcovers PactFlow and self-hosted setup, required secrets, and how the gate decides.SR-211 — Upgrade
openapi-validation.ymloff Node 18 / v3 actionsBoth jobs now use
actions/checkout@v4and the./.github/actions/setup-nodecomposite (Node 20 + npm caching), replacingcheckout@v3/setup-node@v3/node-version: '18'/ manualnpm ci. Matches every other Node workflow in the repo.SR-210 — Replace archived
actions-rs/toolchain@v1inrelease.ymlbuild-artifactsnow uses./.github/actions/setup-rustwithtargets: wasm32-unknown-unknown, matching every other Rust job.stellar-cliinstall and WASM optimize steps unchanged.Incidental fix
deploy-staging.yml'ssmoke-testsjob referencedneeds.build-images.outputs.sha_shortwithout depending onbuild-images— added it toneeds.Testing
node scripts/check-alert-runbooks.js→ passesscripts/pact-*.shpassbash -ncheck-markdown-links.jsfailure count went from 16 → 14 (remaining are pre-existing, in files unrelated to this PR)tsc,vitest,promtool,actionlint. Follow-ups: create the broker / PactFlow account and setPACT_BROKER_BASE_URL+PACT_BROKER_TOKEN(seedocs/PACT_BROKER.md); re-runopenapi-validationagainst a PR touchingapi/openapi.yamlto confirm Node 20; tag a test release to confirmrelease.ymlbuild output is unchanged.closes #1354
closes #1353
closes #1359
closes #1363