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

CI: Add a step to verify that no migrations are missing #8267

Merged
merged 1 commit into from
Aug 8, 2024

Conversation

SpecLad
Copy link
Contributor

@SpecLad SpecLad commented Aug 6, 2024

Motivation and context

Apparently, I forgot to add a migration in #8144 (see #8162). This will ensure that such goofs no longer happen.

How has this been tested?

I've tested it by adding a deliberately broken change to this PR.

Checklist

  • I submit my changes into the develop branch
  • [ ] I have created a changelog fragment
  • [ ] I have updated the documentation accordingly
  • [ ] I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • [ ] I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • New Features
    • Added a new job step for verifying database migrations in the CI/CD workflow.
  • Improvements
    • Enhanced Docker command for schema verification, simplifying the workflow.
    • Ensured database schema consistency by enforcing a non-null chunk_size value in data models, improving data integrity.

Copy link
Contributor

coderabbitai bot commented Aug 6, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent changes enhance the GitHub Actions workflows by streamlining Docker commands and adding a new verification step for database migrations. These updates improve schema integrity and ensure that the database is aligned with application models. Additionally, modifications to the Data model enforce a mandatory chunk_size, bolstering data integrity. Overall, the updates contribute to a more robust CI/CD process.

Changes

Files Change Summary
.github/workflows/full.yml, Streamlined Docker command by removing entry point; added "Verify migrations" step to check for pending database migrations.
.github/workflows/main.yml Similar changes as in full.yml, enhancing schema verification and migration checks.
cvat/apps/engine/models.py Modified chunk_size field in Data model to disallow null values, ensuring data integrity.

Poem

🐰 In the meadow where code does play,
Changes bloom like flowers in May.
With migrations checked and schema refined,
Our data dances, perfectly aligned.
Hooray for the workflow, so strong and bright,
A joyful leap into the coding night! 🌙✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6e30164 and 01edfd8.

Files selected for processing (3)
  • .github/workflows/full.yml (1 hunks)
  • .github/workflows/main.yml (1 hunks)
  • cvat/apps/engine/models.py (1 hunks)
Additional comments not posted (5)
.github/workflows/full.yml (2)

148-151: LGTM!

The code changes are approved. The Docker command for verifying migrations is correctly formatted.


136-143: Ensure the Docker image tag is correct.

The Docker image tag used in the docker run command should be verified to ensure it matches the tag used during the build step.

Verification successful

The Docker image tag is correct.

The CVAT_VERSION variable is set to "local" and is used consistently in both the build step and the docker run command to verify the API schema.

  • .github/workflows/full.yml: CVAT_VERSION is set to "local".
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the Docker image tag used in the `docker run` command matches the tag used during the build step.

# Test: Search for the build step and extract the tag. Expect: The tag should match the tag used in the `docker run` command.
rg --type yaml -A 5 'CVAT server. Build and push' .github/workflows/full.yml

Length of output: 284


Script:

#!/bin/bash
# Description: Extract the Docker image tag used in the build step within the .github/workflows/full.yml file.

# Search for the definition of the CVAT_VERSION variable or any tag-related information.
rg --type yaml -A 5 'CVAT_VERSION' .github/workflows/full.yml

Length of output: 1430

.github/workflows/main.yml (2)

110-113: LGTM!

The code changes are approved. The Docker command for verifying migrations is correctly formatted.


98-105: Ensure the Docker image tag is correct.

The Docker image tag used in the docker run command should be verified to ensure it matches the tag used during the build step.

Verification successful

The Docker image tag is correct.

The Docker image tag cvat/server used in the docker run command matches the tag used during the build step.

  • Build step tag: cvat/server
  • Run command tag: cvat/server
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the Docker image tag used in the `docker run` command matches the tag used during the build step.

# Test: Search for the build step and extract the tag. Expect: The tag should match the tag used in the `docker run` command.
rg --type yaml -A 5 'CVAT server. Build and push' .github/workflows/main.yml

Length of output: 311


Script:

#!/bin/bash
# Description: Search for the Docker image tag used in the build step within the .github/workflows/main.yml file.

# Test: Extract the Docker image tag used during the build step.
rg --type yaml -A 10 'docker/build-push-action@v3' .github/workflows/main.yml

Length of output: 836

cvat/apps/engine/models.py (1)

220-220: Ensure data migration for existing records.

Changing null=True to null=False requires a data migration to ensure existing records comply with the new constraint.

@SpecLad SpecLad force-pushed the rd/makemigrations-check branch 2 times, most recently from 31ec494 to 536a327 Compare August 7, 2024 09:39
Copy link

sonarcloud bot commented Aug 7, 2024

Copy link
Contributor

@zhiltsov-max zhiltsov-max left a comment

Choose a reason for hiding this comment

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

It's a nice addition, I also wanted to create such a check after several similar incidents.

@SpecLad SpecLad merged commit 52ab96e into cvat-ai:develop Aug 8, 2024
33 checks passed
@SpecLad SpecLad deleted the rd/makemigrations-check branch August 8, 2024 12:05
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