Repository navigation
Add .github/README.md documenting CI/release workflows - #841
Open
shambupujar wants to merge 1 commit into
Open
shambupujar wants to merge 1 commit into
shambupujar wants to merge 1 commit into
Conversation
Catalogs every workflow's trigger, the release sequence, and each job's external dependencies (secrets, AWS roles/Secrets Manager paths, self-hosted runners, GitHub environment gates, third-party services), mirroring the same reference doc added to babylon-node.
|
Docker tags |
|
Docker tags |
|
Docker tags |
This branch has not been deployed
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
Adds
.github/README.mdas a reference doc for the 8 workflows in.github/workflows/, mirroring the same doc already added to thebabylon-noderepo. There was no existing documentation covering which workflows run automatically vs. need manual dispatch, the release sequence, or what each job depends on externally.main.yml,build-typescript-sdk.yml,postman.yml,pr-namespace-deletion.yml,release-drafter.yml,releases.yml.publish-typescript-sdk.yml, andpostman.yml'sworkflow_dispatchpath.docs/releasing-new-version.md's existing runbook.selfhosted-ec2-ubuntu-22-arm-4corefor CI vs.babylon-gateway-armfor releases — two separate ARM pools), GitHub environment gates (Postman,release), and third-party services (Docker Hub, SonarCloud, Postman, Jenkins, a Cloudflare-fronted webhook dispatcher).Details
Also flags a few things found while cataloging, in the "Notes" section of the README itself rather than changing behavior here:
postman.ymlandpr-namespace-deletion.ymlboth use a hardcoded literal AWS role ARN instead of thesecrets.GH_BABYLON_GATEWAY_SECRETS_READ_ACCESS_ROLEreferencemain.ymluses for the same role — worth reconciling separately.ephemeral-deploy-and-testonly triggers a Jenkins job; a green check there means the job was triggered, not that it passed.publish-typescript-sdk.ymlexplicitly unsetsNODE_AUTH_TOKEN/NPM_CONFIG_USERCONFIGbeforenpm publish, so its actual publish auth source isn't visible in the workflow file itself.Testing
Documentation-only change — no workflow behavior modified. Verified the documented triggers, environment gates (
Postman,release), self-hosted runner labels, and secret names directly against the current.github/workflows/*.ymland.github/actions/*/action.ymlfiles.