fix: update README badge paths and rename streaming/ to uploads/ #503
Conversation
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
- Fix broken badge paths in README files that referenced incorrect package folders - Rename streaming/ folder to uploads/ for better clarity - Update pnpm-workspace.yaml to use uploads/ instead of streaming/ - Update CI workflow to reference uploads/ folder - Update all badge URLs to use correct folder paths: - streaming/ packages now use uploads/ - postgres/ packages now use postgres/ - pgpm/ packages now use pgpm/ - graphql/ packages now use graphql/
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Add normalizePackageJsonForSnapshot helper function that replaces dependency versions with '<VERSION>' placeholder to prevent snapshot failures when boilerplate/tooling dependency versions change. The helper preserves versions for explicitly installed packages (specified via preserveVersionsFor option) while normalizing devDependencies and other tooling versions. This fixes the flaky pgpm/cli tests that were failing due to makage and pgsql-test version bumps.
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.
fix: update README badge paths and rename streaming/ to uploads/
Summary
This PR fixes broken version badge URLs in README files across the monorepo and renames the
streaming/folder touploads/for better clarity about its purpose (file upload utilities for S3).The badge URLs were pointing to incorrect folder paths (e.g.,
packages%2Fexplorerinstead ofgraphql%2Fexplorer), causing the version badges to fail to load. All badge paths have been updated to reflect the actual folder structure.Changes include:
streaming/folder touploads/(10 packages)graphql/,postgres/,pgpm/, anduploads/folderspnpm-workspace.yamlto referenceuploads/*uploads/instead ofstreaming/Updates since last revision
Added a fix for flaky snapshot tests in
pgpm/clithat were failing when boilerplate dependency versions changed (e.g.,makage,pgsql-test):normalizePackageJsonForSnapshot()helper inpgpm/cli/test-utils/cli.tsthat replaces dependency versions with<VERSION>placeholderinit.install.test.tsto use the normalizer while preserving versions for explicitly installed test packages (@pgpm-testing/base32,@pgpm-testing/utils)Review & Testing Checklist for Human
normalizePackageJsonForSnapshotfunction logic - ensure it correctly handles all dependency fields and thepreserveVersionsForoptionpreserveVersionsForarrays ininit.install.test.tsinclude the correct packages (should match what each test installs)streaming/references:grep -r "streaming/" --include="*.yaml" --include="*.json" --include="*.md"Notes
Link to Devin run: https://app.devin.ai/sessions/a4fde64468004af8a5a915dac64fb642
Requested by: Dan Lynch ([email protected]) / @pyramation
Build was verified locally with
pnpm buildpassing successfully. Snapshot tests pass withnpx jest __tests__/init.install.test.ts.