Skip to content

docs(readme): add CI status badge#1

Merged
TheAlexPG merged 2 commits intomainfrom
docs/add-ci-badge
Apr 23, 2026
Merged

docs(readme): add CI status badge#1
TheAlexPG merged 2 commits intomainfrom
docs/add-ci-badge

Conversation

@TheAlexPG
Copy link
Copy Markdown
Owner

Summary

Adds a GitHub Actions status badge for the deploy.yml workflow at the top of the README so readers (and we) can see at a glance whether main is currently green.

Type of change

  • docs — docs only

Test plan

  • npm run build still clean (no README impact on build, but verified).
  • Badge URL manually resolved — points at /actions/workflows/deploy.yml, clicking opens the runs page.
  • Also serves as the inaugural test of the new protected-main + feature-branch + PR-merge workflow.

Screenshots / recordings

Badge renders at the top of the README, above the existing License / FastAPI / Postgres / React / TypeScript / TailwindCSS badges.

Database / migration notes

None.

Breaking changes

None.

Related

First PR after switching main to a protected branch — verifies the workflow (CI gate + squash-merge) end-to-end.

At-a-glance signal for contributors whether main is currently green.
Links straight to the deploy workflow runs page on click.
The previous trigger was push-only, so PRs never fired the workflow —
required status checks stayed "Expected / Waiting" forever and the
protected main branch could not be merged into from any PR.

Add a pull_request trigger so build-backend and build-frontend run on
every PR targeting main, turning green/red in the PR check widget as
intended. Gate the deploy job with an if: condition so it only fires
on real pushes to main (i.e. post-merge), not on every PR — otherwise
every open PR would race to SSH into prod.

Net effect on the workflow:
- PR opened/updated → build-backend + build-frontend run → deploy
  skipped → PR mergeable once both builds green.
- PR merged to main → push event → all three jobs run → deploy
  performs the actual rollout.
@TheAlexPG TheAlexPG merged commit de0f4d3 into main Apr 23, 2026
3 checks passed
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.

1 participant