Skip to content

chore: validate schema generation in CI#13

Draft
sakinaroufid wants to merge 3 commits intoUniversal-Commerce-Protocol:mainfrom
sakinaroufid:chore/add-schema-validation-ci
Draft

chore: validate schema generation in CI#13
sakinaroufid wants to merge 3 commits intoUniversal-Commerce-Protocol:mainfrom
sakinaroufid:chore/add-schema-validation-ci

Conversation

@sakinaroufid
Copy link

@sakinaroufid sakinaroufid commented Jan 12, 2026

Description

Adds a pre-commit hook to catch schema sync issues before commit, plus keeps CI validation as a safety net.

Right now you can edit source schemas, forget to run generate_schemas.py, and CI will pass. Then downstream tools break because spec/ is out of sync.

The pre-commit hook gives instant feedback (seconds instead of waiting for CI). But kept the CI check too in case someone bypasses pre-commit or doesn't have it installed.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected, including removal of schema files or fields)
  • Documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@sakinaroufid sakinaroufid force-pushed the chore/add-schema-validation-ci branch 2 times, most recently from 65dd4c6 to 4362390 Compare January 12, 2026 06:31
@sakinaroufid sakinaroufid force-pushed the chore/add-schema-validation-ci branch from b5c5eb4 to 8c6661c Compare January 12, 2026 07:12
@sakinaroufid sakinaroufid reopened this Jan 12, 2026
@sakinaroufid sakinaroufid force-pushed the chore/add-schema-validation-ci branch 2 times, most recently from 5d50dda to 5a8df57 Compare January 12, 2026 07:39
@sakinaroufid sakinaroufid marked this pull request as ready for review January 12, 2026 07:48
@sakinaroufid sakinaroufid requested a review from a team January 12, 2026 07:48
@nearlyforget
Copy link
Contributor

Thank you for this contribution. We are evaluating the changes and will provide a formal response within 1 - 2 weeks.

@nearlyforget
Copy link
Contributor

To help us review this more effectively, could you please break this CI update down into multiple logical pieces?

Handling these as distinct logical units (e.g., separate commits or steps) allows us to validate the logic for each component independently and ensures our CI pipeline is modular.

Thanks for your help!

@sakinaroufid
Copy link
Author

To help us review this more effectively, could you please break this CI update down into multiple logical pieces?

Handling these as distinct logical units (e.g., separate commits or steps) allows us to validate the logic for each component independently and ensures our CI pipeline is modular.

Thanks for your help!

Thanks for the feedback! @nearlyforget

Currently, this PR includes:

  1. A new schema-validation.yml workflow file (schema generation, validation, and sync checks)
  2. A pre-commit hook for local validation
  3. Updates to workflow path triggers

I can split this into separate PRs if that works better for review. Just to clarify the process - are you a maintainer on this project? I want to make sure I'm following the right review workflow.

Cheers,
S

@nearlyforget
Copy link
Contributor

Apologies for the late reply @sakinaroufid. There has been some changes on CI workflow, and yes, I'm a maintainer.
Would you be able to break it down into 3 parts you described and resolve the conflicts?

@sakinaroufid sakinaroufid marked this pull request as draft February 28, 2026 10:43
@sakinaroufid sakinaroufid force-pushed the chore/add-schema-validation-ci branch 4 times, most recently from ef7f02a to 528a988 Compare February 28, 2026 12:20
@sakinaroufid sakinaroufid force-pushed the chore/add-schema-validation-ci branch 4 times, most recently from 194b5d9 to 26d9d6f Compare February 28, 2026 19:38
@sakinaroufid
Copy link
Author

Hi @nearlyforget, I've split this into 3 separate PRs as requested!

  1. chore(ci): add schema validation workflow #230 — Schema validation CI workflow + generator bug fix
  2. chore(pre-commit): add local schema generation sync check #231 — Pre-commit hook for local schema sync check (depends on chore(ci): add schema validation workflow #230)
  3. chore(ci): update workflow path triggers and improve docs build #232 — Workflow path triggers + docs build improvements

All three pass CI and have no conflicts with main. Happy to address any feedback on the individual PRs.

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