You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
dependabot[bot] f25d040214 Bump django from 4.0.6 to 4.1 1 week ago
.github chore(deps): update wearerequired/lint-action action to v2.0.1 1 month ago
django_migration_fixer Update settings.py 3 months ago
docs Update docs. (#140) 11 months ago
migration_fixer Updated submodule. 6 months ago
.coveragerc Update .coveragerc 1 year ago
.editorconfig Updated .editorconfig 8 months ago
.gitignore Added documentation (#19) 1 year ago
.gitmodules Improve test coverage (#43) 1 year ago
.pep8speaks.yml Updated .pep8speaks.yml 1 year ago
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate (#249) 1 month ago
.pyup.yml Updated .pyup.yml 1 year ago
.whitesource Added .whitesource 1 year ago
CHANGELOG.md Upgraded v1.3.4 → v1.3.5 (#197) 6 months ago
CODE_OF_CONDUCT.md Added CODE_OF_CONDUCT.md 1 year ago
LICENSE Update LICENSE 1 year ago
MANIFEST.in Update MANIFEST.in 11 months ago
Makefile Updated requirements.txt and fixed Makefile. (#153) 11 months ago
README.md Update README.md (#241) 3 months ago
action.yml Update action.yml 11 months ago
conftest.py Increase test coverage. (#62) 1 year ago
manage.py Added mypy configuration and updated tox test. (#14) 1 year ago
mkdocs.yml Update docs. (#140) 11 months ago
mypy.ini Added mypy configuration and updated tox test. (#14) 1 year ago
renovate.json Added renovate.json 1 year ago
requirements.txt Bump django from 4.0.6 to 4.1 1 week ago
setup.cfg Upgraded v1.3.4 → v1.3.5 (#197) 6 months ago
setup.py Revert "chore(deps): update dependency pymdown-extensions to >=9.5,<9.6" (#246) 2 months ago
tox.ini Update tox.ini 1 year ago

README.md

logo

Codacy Badge codecov Total alerts Language grade: Python Codacy Badge

Test Upload Python Package Run linters Updates Code style: black

PyPI PyPI - Python Version PyPI - Django Version Downloads Public workflows that use this action.

django-migration-fixer

Resolve django makemigrations multiple leaf nodes in the migration graph by ensuring that migration files and dependencies are always ordered regardless of remote changes, without having to run python manage.py makemigrations --merge.

Table of Contents

Features

  • Resolve migration conflicts on Pull Request branches
  • Resolve migration conflicts on the default branch (NOT RECOMMENDED)

Installation

$ pip install django-migration-fixer

Add migration_fixer to your INSTALLED_APPS


INSTALLED_APPS = [
    ...,
    "migration_fixer",
    ...,
]

Usage

Merge the changes from the default branch or the target branch of the pull request.

$ git checkout main # OR: develop/another parent feature branch
$ git pull
$ git checkout feature/xxxx
$ git merge main

Fix the migration conflicts

$ python manage.py makemigrations --fix

By default this uses main as the default branch

Example

After merging the default branch

Screen Shot 2021-07-06 at 2 21 46 PM

After running django-migration-fixer

Screen Shot 2021-07-06 at 2 22 31 PM

Assumptions

The final migration on the default branch would be used as the base for all subsequent migrations.

Specifying a different default branch

Run:

$ python manage.py makemigrations -b master --fix

Setup using Github Actions

NOTE:

  • To get this action to work you'll need to install django-migration-fixer and update your INSTALLED_APPS setting.

Inputs

Input type required default description
managepy-path string true ./manage.py The location of manage.py.
default-branch string false ${{ github.base_ref }} The default branch or
target branch of a Pull request.
force-update string false Force update the target branch
locally when git fetch fails.
skip-default-branch-update string false Skip pulling the latest
changes from the default branch.
name: Fix django migrations

on:
  pull_request:
    branches:
      - main

jobs:
  fix-migrations:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: '3.6.x'

      - name: Upgrade pip
        run: |
                    pip install -U pip

      - name: Install project dependencies
        run: |
                    make install

      - name: Run django-migration-fixer
        uses: tj-django/django-migration-fixer@v1.3.5
        with:
          managepy-path: /path/to/manage.py

      - name: Verify Changed files
        uses: tj-actions/verify-changed-files@v7.1
        id: verify-changed-files
        with:
          files: |
                          /path/to/migrations

      - name: Commit migration changes
        if: steps.verify-changed-files.outputs.files_changed == 'true'
        run: |
          git config --local user.email "github-actions[bot]@users.noreply.github.com"
          git config --local user.name "github-actions[bot]"
          git add /path/to/migrations
          git commit -m "Updated migrations"          

      - name: Push migration changes
        if: steps.verify-changed-files.outputs.files_changed == 'true'
        uses: ad-m/github-push-action@master
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          branch: ${{ github.ref }}

See: https://github.com/tj-django/django-clone for a working example.

Test Platforms

Found a Bug?

To file a bug or submit a patch, please head over to django-migration-fixer on github.

If you feel generous and want to show some extra appreciation:

Support me with a

Buy me a coffee