Skip to content

chore: add logo, license, and version badges to all package READMEs#822

Merged
pyramation merged 1 commit intomainfrom
devin/1773553195-readme-badges
Mar 15, 2026
Merged

chore: add logo, license, and version badges to all package READMEs#822
pyramation merged 1 commit intomainfrom
devin/1773553195-readme-badges

Conversation

@pyramation
Copy link
Contributor

Summary

Standardizes README headers across all packages in the monorepo so every package has the Constructive logo, CI status badge, MIT license badge, and npm version badge.

Changes by category:

  • 25 packages — added full header block (logo + all 3 badges) where none existed: functions/*, graphile/{connection-filter,misc-plugins,postgis,search,sql-expression-validator,upload-plugin}, graphql/{env,playwright-test,test-app,types}, jobs/* (10 packages), packages/{cli,smtppostmaster}, pgpm/env, sdk/constructive-node
  • 5 packages — added missing badge <p> block to READMEs that already had the logo: pgpm/logger, postgres/pg-env, sdk/constructive-{cli,react,sdk}
  • 2 packages — updated stale launchql/launchql references to constructive-io/constructive: graphile/graphile-cache, packages/csv-to-pg
  • 1 package — replaced supatest.svg with outline-logo.svg: postgres/supabase-test

Non-package directories (docker/, jobs/ root) were intentionally skipped (no package.json).

Review & Testing Checklist for Human

  • SDK auto-generated READMEs: sdk/constructive-cli, sdk/constructive-react, and sdk/constructive-sdk contain <!-- DO NOT EDIT --> codegen markers. Verify the next cnc codegen run won't strip the newly added badge block, or decide if the codegen template itself should be updated instead.
  • supabase-test logo: Confirm replacing supatest.svg with outline-logo.svg is desired — the original may have been an intentionally distinct logo for that package.
  • csv-to-pg link text: The blanket launchql/launchqlconstructive-io/constructive replacement also affected display text in markdown links (e.g., launchql/launchql-genconstructive-io/constructive-gen). Verify the link labels still read correctly.
  • Spot-check a few badge URLs render correctly on GitHub (version badges use ?filename=<url-encoded-path> — confirm shields.io resolves them).

Notes

  • Docs-only change — no code, build, or runtime impact.
  • docker/README.md and jobs/README.md (directory-level, no package.json) were intentionally left unchanged.
  • The root README.md was also left as-is (it already has logo + CI + license + deepwiki badges; no npm version badge since it's not published).

Link to Devin session: https://app.devin.ai/sessions/0f858efb5df0421794225008cf8da72a
Requested by: @pyramation

- Add standard logo HTML header and CI/license/version badges to 25 packages missing them entirely
- Add missing license and version badges to 5 packages that only had the logo
- Fix old launchql/launchql references to constructive-io/constructive in 2 packages
- Standardize supabase-test logo to use outline-logo.svg
@devin-ai-integration
Copy link
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@pyramation pyramation merged commit edc03ca into main Mar 15, 2026
43 checks passed
@pyramation pyramation deleted the devin/1773553195-readme-badges branch March 15, 2026 05:44
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