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

Remove --merge and --noinput flags in Django migration check #3329

Merged
merged 1 commit into from
Nov 8, 2023

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Nov 8, 2023

Fixes

Fixes #3310 by @sarayourfriend

Description

This PR updates the migration check in CI to properly raise errors in case of migration issues. The flag --merge overwrites the --check behaviour. Also --noinput is redundant.

Just passing --check checks for both cases:

  • model differs from migrations and a new migration is needed
  • two leaf migrations exist and a merge migration is needed

Testing Instructions

  1. Check out the main branch to the point where it has a migration issue: b2a3970
  2. Run just api/dj makemigrations --check --noinput --merge. See no error.
  3. Run the fixed command just api/dj makemigrations --check. See the expected error.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@dhruvkb dhruvkb added 🟨 priority: medium Not blocking but should be addressed soon 🛠 goal: fix Bug fix 🤖 aspect: dx Concerns developers' experience with the codebase 🧱 stack: api Related to the Django API labels Nov 8, 2023
@dhruvkb dhruvkb requested a review from a team as a code owner November 8, 2023 08:28
@github-actions github-actions bot added the 🧱 stack: mgmt Related to repo management and automations label Nov 8, 2023
Copy link
Collaborator

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

🤦 I guess it never worked to begin with, lol! Thanks for finding the fix 🙏

@AetherUnbound AetherUnbound changed the title Remove --merge and --noinput flags Remove --merge and --noinput flags in Django migration check Nov 8, 2023
Copy link
Collaborator

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this!

@dhruvkb dhruvkb merged commit ac42b54 into main Nov 8, 2023
70 checks passed
@dhruvkb dhruvkb deleted the fix_migration_check branch November 8, 2023 21:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🛠 goal: fix Bug fix 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API 🧱 stack: mgmt Related to repo management and automations
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Dangling migration in API
3 participants