Skip to content
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

Ensure PR description contains compatibility info & rollout plan when DB schema is changed #6150

Conversation

taylanisikdemir
Copy link
Member

@taylanisikdemir taylanisikdemir commented Jul 1, 2024

What changed?
Adding a new github workflow to run on schema changes and fails if the PR template is missing critical information.

Why?
To warn the developer about potential breaking changes.

How did you test it?
Made some changes under schema/ folder and validated the new github workflow fails. See screenshot:

Screenshot 2024-07-01 at 12 08 33 PM

@coveralls
Copy link

coveralls commented Jul 1, 2024

Pull Request Test Coverage Report for Build 01906f63-55bd-433b-bb88-db8bfd7cbb54

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 52 unchanged lines in 13 files lost coverage.
  • Overall coverage decreased (-0.02%) to 71.507%

Files with Coverage Reduction New Missed Lines %
common/task/weighted_round_robin_task_scheduler.go 1 89.05%
common/persistence/sql/sqlplugin/postgres/task.go 2 73.4%
service/matching/tasklist/db.go 2 73.23%
common/task/fifo_task_scheduler.go 2 85.57%
service/matching/tasklist/matcher.go 2 90.91%
service/history/task/task.go 3 84.81%
common/log/tag/tags.go 3 49.64%
common/persistence/statsComputer.go 3 98.18%
service/history/task/transfer_standby_task_executor.go 5 86.64%
service/matching/tasklist/task_list_manager.go 5 76.45%
Totals Coverage Status
Change from base Build 019060e3-e556-4061-8a61-c080801be36f: -0.02%
Covered Lines: 105296
Relevant Lines: 147252

💛 - Coveralls

@taylanisikdemir taylanisikdemir changed the title Detect schema change and warn Ensure PR description contains critical information when DB schema is changed Jul 1, 2024
@taylanisikdemir taylanisikdemir marked this pull request as ready for review July 1, 2024 19:11
@taylanisikdemir taylanisikdemir changed the title Ensure PR description contains critical information when DB schema is changed Ensure PR description contains compatibility info & rollout plan when DB schema is changed Jul 1, 2024
Copy link
Contributor

@demirkayaender demirkayaender left a comment

Choose a reason for hiding this comment

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

Talked offline. Looks good after the comments.

Copy link
Member

@Groxx Groxx left a comment

Choose a reason for hiding this comment

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

Makes sense, reasonably-loose verification, and pretty easy to replicate to new templates. 👍 I like it

@taylanisikdemir taylanisikdemir enabled auto-merge (squash) July 1, 2024 21:44
@taylanisikdemir taylanisikdemir merged commit b5a79d2 into cadence-workflow:master Jul 1, 2024
19 checks passed
@taylanisikdemir taylanisikdemir deleted the taylan/schema_change_reminder branch July 1, 2024 22: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.

4 participants