Skip to content

Improve breaking change CI #12816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 24, 2025
Merged

Improve breaking change CI #12816

merged 3 commits into from
Jun 24, 2025

Conversation

FelixMalfait
Copy link
Member

It used to post a comment if the API schema changed, even if there's no breaking change. I thought this could be OK as an FYI. But it is not since now we generate the examples dynamically with Faker the OpenAPI schema is always different

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

PR Summary

Optimizes CI workflow to reduce noise by only commenting on breaking API changes, addressing false positives from dynamic example generation with Faker.

  • Modified .github/workflows/ci-breaking-changes.yaml to skip commenting on non-breaking REST Metadata API changes
  • Improved PR title check syntax using backticks for template literals
  • Added specific reporting logic to only generate comments for actual breaking changes
  • Prevents redundant comments caused by automatic schema changes from Faker example generation

1 file reviewed, no comments
Edit PR Review Bot Settings | Greptile

@charlesBochet charlesBochet merged commit 21f9db1 into main Jun 24, 2025
38 checks passed
@charlesBochet charlesBochet deleted the breaking-change-ci-improvement branch June 24, 2025 12:53
abdulrahmancodes pushed a commit to abdulrahmancodes/twenty that referenced this pull request Jun 26, 2025
It used to post a comment if the API schema changed, even if there's no
breaking change. I thought this could be OK as an FYI. But it is not
since now we generate the examples dynamically with Faker the OpenAPI
schema is always different
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