Skip to content

docs(guides): add CI.md mapping GitHub workflows to just recipes#1774

Open
ThodoreBurne-Jonesbj wants to merge 1 commit intobase:mainfrom
ThodoreBurne-Jonesbj:docs/guides-ci-md
Open

docs(guides): add CI.md mapping GitHub workflows to just recipes#1774
ThodoreBurne-Jonesbj wants to merge 1 commit intobase:mainfrom
ThodoreBurne-Jonesbj:docs/guides-ci-md

Conversation

@ThodoreBurne-Jonesbj
Copy link
Copy Markdown

Summary

Adds docs/guides/CI.md: a contributor-oriented map between GitHub Actions (especially ci.yml) and local just recipes.

Why

Contributors run just ci locally but CI runs many parallel jobs with different flags (--locked, ci profile, affected tests on PRs). Without a single place to read this, it is easy to assume local recipes match CI exactly or to miss that just ci runs fix (mutating) first.

What’s in the doc

  • TL;DR: CI never auto-fixes; difference between check-clippy / test and check-clippy-ci / test-ci / test-affected-ci.
  • just ci, just pr, and useful recipes (build-ci, devnet steps, actions::test).
  • Overview table for main workflow files and accurate on: notes (e.g. ci.yml push only to main, zepter PRs targeting main, docs-specs-ci + workflow_dispatch).
  • ci.yml job ↔ command table and a Gaps section listing what just ci does not cover.
  • Pointer to .github/actions/setup and CONTRIBUTING.md.

Scope

Documentation only; no workflow or Justfile changes.

Document just ci/pr/check, CI vs local fix behavior, ci.yml job commands,
other workflows (action-tests, no-std, zepter, lychee, specs, docker),
and gaps versus the full GitHub matrix.
@cb-heimdall
Copy link
Copy Markdown
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 29, 2026

@ThodoreBurne-Jonesbj is attempting to deploy a commit to the Coinbase Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants