Skip to content

Run pgdog configcheck in CI#7

Merged
niclaflamme merged 4 commits intomainfrom
nic/configcheck
Aug 4, 2025
Merged

Run pgdog configcheck in CI#7
niclaflamme merged 4 commits intomainfrom
nic/configcheck

Conversation

@niclaflamme
Copy link
Contributor

@niclaflamme niclaflamme commented Aug 4, 2025

Goal

  • The idea is to prevent us from uploading illegal pgdog.toml and users.toml snippets.
  • Add configs test #5

Todo

  • Add a .github actions

Known issue

  • Extraneous names do not cause configs to fail.
  • The extra fields are ignores,
  • The misspelled field default to it's default.
  • Below is a valid config snippet.
  • This should be fixed in the main repo, not this repo, obv.
  • The docker image is tied to a specific sha because main is currently cached?
[admin_badass]
password = "hunter2"
  • In other words, if the goal is to prevent users from copying our typos and getting results they don't expect, these tests don't check for extra property typos.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Aug 4, 2025

Deploying pgdog-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 56ae371
Status: ✅  Deploy successful!
Preview URL: https://aac3a11c.pgdog-docs.pages.dev
Branch Preview URL: https://nic-configcheck.pgdog-docs.pages.dev

View logs

@niclaflamme niclaflamme changed the title Run Configcheck no CI Run pgdog configcheck in CI Aug 4, 2025
@niclaflamme
Copy link
Contributor Author

fixed issue with users.toml overriding failed pgdog configs.
pgdogdev/pgdog#303

@niclaflamme niclaflamme requested a review from levkk August 4, 2025 16:48
@niclaflamme
Copy link
Contributor Author

it's ran as a script instead as part of a unit test suite.
could be revisited later if we feel the need to run tests as a blob tests/**/*.test.ts or something.

Copy link
Contributor

@levkk levkk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@niclaflamme niclaflamme merged commit a17e0c2 into main Aug 4, 2025
2 checks passed
@niclaflamme niclaflamme deleted the nic/configcheck branch August 4, 2025 18:33
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