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

Missing Documentation on how to combine migrations in Django #439

Open
2 tasks
vanessaavviles opened this issue Nov 14, 2024 · 0 comments
Open
2 tasks

Missing Documentation on how to combine migrations in Django #439

vanessaavviles opened this issue Nov 14, 2024 · 0 comments
Labels
complexity: small All steps are laid out in detail so that someone new to the project can work on it feature: docs: PD team documentation documentation on PD team processes and architecture, etc. good first issue Good for newcomers ready for dev lead s: PD team stakeholder: People Depot Team size: 0.25pt Can be done in 0.5-1.5 hours
Milestone

Comments

@vanessaavviles
Copy link
Member

vanessaavviles commented Nov 14, 2024

Overview

We need to add a description of how to combine migrations in Django so that developers can integrate changes effectively. For example, if max_migration.txt is at 0027_... and you want to combine 0025_, 0026_, 0027_ into one.

Action Items

Resources/Instructions/Tags

Documentation Addition Notes

What's missing?

  • The process for combining migrations in Django is:
  1. Roll back core app migrations to 0024

    ./scripts/migrate.sh core 0024
  2. Delete unwanted migration files

    rm app/core/migrations/00{25,26,27}_*
  3. Recreate max_migration.txt for core app

    docker-compose exec web python manage.py create_max_migration_files --recreate core
    # the file core/max_migration.txt should contain "0024_..."
  4. Create combined migration file for core app

    ./script/migrate.sh core

Where should it go?

When would this information have been useful?

  • Many initial passes for PRs have multiple migration files that should really be a single Create Table migration

Which roles will benefit most from this information?

  • Back end/ Dev
@vanessaavviles vanessaavviles self-assigned this Nov 14, 2024
@vanessaavviles vanessaavviles moved this to 🏗In progress-actively working in P: PD: Project Board Nov 14, 2024
@vanessaavviles vanessaavviles added feature: docs: PD team documentation documentation on PD team processes and architecture, etc. size: 0.25pt Can be done in 0.5-1.5 hours s: PD team stakeholder: People Depot Team ready for dev lead complexity: small All steps are laid out in detail so that someone new to the project can work on it and removed role: missing size: missing feature: missing stakeholder: missing complexity: missing labels Nov 14, 2024
@vanessaavviles vanessaavviles added this to the w. Ongoing milestone Nov 14, 2024
@shmonks shmonks added the good first issue Good for newcomers label Nov 14, 2024
@shmonks shmonks moved this from 🏗In progress-actively working to 📋Prioritized Backlog in P: PD: Project Board Nov 14, 2024
@shmonks shmonks moved this from 📋Prioritized Backlog to 🏗In progress-actively working in P: PD: Project Board Nov 15, 2024
@vanessaavviles vanessaavviles removed their assignment Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity: small All steps are laid out in detail so that someone new to the project can work on it feature: docs: PD team documentation documentation on PD team processes and architecture, etc. good first issue Good for newcomers ready for dev lead s: PD team stakeholder: People Depot Team size: 0.25pt Can be done in 0.5-1.5 hours
Projects
Status: 🏗In progress-actively working
Development

No branches or pull requests

2 participants