Skip to content

Latest commit

 

History

History
364 lines (258 loc) · 8.89 KB

migration.md

File metadata and controls

364 lines (258 loc) · 8.89 KB

Migration Guide

This guide documents breaking changes between mxmake versions and how to migrate your projects.

Version 2.0.1 (unreleased)

Added: Monorepo Support

New Feature: Python projects can now be located in a subdirectory relative to the Makefile.

Purpose: Support monorepo setups with multiple applications (e.g., frontend + backend) in one repository.

New Setting: PROJECT_PATH_PYTHON in the core.base domain.

Example Configuration:

# In your Makefile
PROJECT_PATH_PYTHON?=backend
# In your mx.ini (specify full paths from repo root)
[settings]
mxmake-test-path = backend/tests
mxmake-source-path = backend/src

Setup Methods:

  1. Auto-detection (recommended):

    uvx mxmake init
# Prompts if pyproject.toml found in subdirectory

  2. CLI flag:

    uvx mxmake init --project-path-python backend

  3. Preseed file:

    topics:
  core:
    base:
      PROJECT_PATH_PYTHON: backend

What Changes:

  • Makefile references: backend/pyproject.toml instead of ./pyproject.toml
  • mx.ini paths: Specify full paths from repository root (e.g., mxmake-test-path = backend/tests)
  • GitHub Actions: Cache uses backend/pyproject.toml for dependency tracking

Migration: None required. This is an opt-in feature with no impact on existing projects.

See Also: Monorepo Support in Getting Started guide.

Version 2.0.0 (2025-10-24)

Dropped: Python 3.9 Support

Breaking Change: Minimum Python version increased from 3.9 to 3.10.

Migration:

  1. Ensure your system has Python 3.10 or later installed
  2. Run mxmake update to regenerate Makefile (automatically updates PYTHON_MIN_VERSION to 3.10)
  3. If needed, customize Python version settings:
    • Using UV: Set UV_PYTHON to desired version: 
      UV_PYTHON?=3.10  # or 3.11, 3.12, 3.13, 3.14
    • Using pip: Ensure PRIMARY_PYTHON points to Python 3.10+: 
      PRIMARY_PYTHON?=python3.10

Removed: MXENV_UV_GLOBAL Setting

Breaking Change: The MXENV_UV_GLOBAL setting has been removed. UV is now automatically detected.

Before (1.x):

PYTHON_PACKAGE_INSTALLER?=uv
MXENV_UV_GLOBAL?=true

After (2.0+):

PYTHON_PACKAGE_INSTALLER?=uv
UV_PYTHON?=3.14  # Optional: specify Python version

Migration:

  1. Run mxmake update (automatically removes MXENV_UV_GLOBAL setting)
  2. UV will be automatically detected if installed globally
  3. If needed, add UV_PYTHON setting to specify Python version: 
    UV_PYTHON?=3.14
  4. To force local UV installation, ensure UV is not in your PATH before running make install

Changed: SOURCES_TARGET Implementation

Critical Fix: SOURCES_TARGET incorrectly used mxdev's -o (offline) flag instead of -f (no fetch).

Impact: This affects projects using mxdev with source checkouts. The -o flag had a bug (fixed in mxdev 5.0).

Migration:

  1. Update mxdev to version 5.0 or later: pip install -U mxdev>=5
  2. Run mxmake update (automatically regenerates Makefile with correct -f flag)

Added: UV_PYTHON Setting

New Feature: Introduced UV_PYTHON setting for semantic clarity.

Purpose:

  • PRIMARY_PYTHON: System interpreter path (e.g., python3, /usr/bin/python3.11)
  • UV_PYTHON: Python version spec for UV (e.g., 3.14, [email protected])

Migration (optional but recommended):

# Old approach (still works)
PYTHON_PACKAGE_INSTALLER?=uv
PRIMARY_PYTHON?=3.14

# New approach (clearer semantics)
PYTHON_PACKAGE_INSTALLER?=uv
UV_PYTHON?=3.14

Version 1.3.0 (2025-09-03)

No breaking changes

Version 1.2.2 (2025-06-30)

No breaking changes

Version 1.2.1 (2025-06-23)

No breaking changes

Version 1.2.0 (2025-06-04)

No breaking changes

Version 1.1.0 (2025-03-20)

No breaking changes

Version 1.0 (2025-02-11)

No breaking changes

Version 1.0a8 (2024-10-24)

No breaking changes

Version 1.0a7 (2024-10-24)

Renamed: npm Domain to nodejs

Breaking Change: The npm domain was renamed to nodejs to better reflect its purpose (Node.js tooling, supporting both npm and pnpm).

Before:

# preseed.yaml or mx.ini
topics:
  js:
    npm:

After:

# preseed.yaml or mx.ini
topics:
  js:
    nodejs:

Migration:

  1. Run mxmake update (automatically uses new nodejs domain name)
  2. If using preseed files, update them to use nodejs instead of npm
  3. The domain now supports both npm and pnpm package managers

Version 1.0a6 (2024-08-02)

Dropped: Python 3.8 Support

Breaking Change: Minimum Python version increased from 3.8 to 3.9.

Migration:

  1. Ensure your project uses Python 3.9 or later
  2. Run mxmake update (automatically updates PYTHON_MIN_VERSION to 3.9)

Note: This change was superseded by version 2.0.0 which requires Python 3.10+.

Version 1.0a5 (2024-06-07)

No breaking changes

Version 1.0a4 (2024-03-12)

Changed: Default venv Folder

Breaking Change: Default virtual environment folder changed from venv to .venv.

Before:

VENV_FOLDER?=venv

After:

VENV_FOLDER?=.venv

Migration:

  1. Run mxmake update (automatically updates default to .venv)
  2. Choose one option:
    • Option A (Use new default): Delete old venv folder, run make install to create .venv
    • Option B (Keep old folder): Edit Makefile to set VENV_FOLDER=venv
  3. Update .gitignore: 
    # Old
venv/

# New
.venv/

Renamed: PYTHON_BIN to PRIMARY_PYTHON

Breaking Change: PYTHON_BIN setting renamed to PRIMARY_PYTHON.

Before:

PYTHON_BIN?=python3

After:

PRIMARY_PYTHON?=python3

Migration:

  1. Run mxmake update (automatically renames PYTHON_BIN to PRIMARY_PYTHON)
  2. If you have custom scripts referencing PYTHON_BIN, update them to use PRIMARY_PYTHON

Removed: MXENV_PATH

Breaking Change: MXENV_PATH variable has been removed. Use $(MXENV_PYTHON) directly.

Before:

$(MXENV_PATH)pip install something
$(MXENV_PATH)pytest tests/

After:

$(MXENV_PYTHON) -m pip install something
$(MXENV_PYTHON) -m pytest tests/

Migration:

  1. Run mxmake update (automatically removes MXENV_PATH)
  2. If you have custom Makefile targets using MXENV_PATH, update them manually:
    • $(MXENV_PATH)pip → $(MXENV_PYTHON) -m pip
    • $(MXENV_PATH)pytest → $(MXENV_PYTHON) -m pytest
    • $(MXENV_PATH)black → $(MXENV_PYTHON) -m black

Version 1.0a3 (2024-02-06)

No breaking changes (added typecheck target, CI config generation, ruff domain)

Version 1.0a2 (2023-07-07)

No breaking changes (fixes and pip.conf support)

Version 1.0a1 (2023-05-05)

Semantic Overhaul: Terminology Changes

Breaking Change: Major terminology changes in custom domain development.

Changes:

  • "Domains" are now called "Topics"
  • "Makefile" is now called "Domain"
  • _SENTINEL variables renamed to _TARGET
  • .sentinels folder renamed to .mxmake-sentinels

Impact: Only affects custom domain/plugin authors, not regular users.

Migration (for plugin developers):

  • Update custom domain files to use new terminology
  • Rename *_SENTINEL variables to *_TARGET: 
    # Before
MYDOM_SENTINEL?=.sentinels/mydom

# After
MYDOM_TARGET?=.mxmake-sentinels/mydom

Renamed: Multiple Domains

Breaking Changes: Several domains renamed for clarity.

Old Name New Name
install packages
files mxfiles
venv mxenv
docs sphinx

Migration:

  1. Run mxmake update (automatically uses new domain names)
  2. If using preseed files with old domain names, update them to use new names

Version 0.1 (2022-05-19)

Initial release - no migration needed.

General Migration Tips

Before Upgrading

  1. Read Release Notes: Check CHANGES.md for your target version
  2. Backup: Commit your current Makefile to version control
  3. Test: If possible, test the upgrade in a separate branch

Upgrade Process

  1. Upgrade mxmake:

    pip install -U mxmake
# or with UV:
uv pip install -U mxmake

  2. Update Makefile:

    mxmake update

  3. Review Changes: Check the diff to ensure settings are preserved

  4. Test: Run make install and make test to verify functionality

Rolling Back

If you encounter issues:

git checkout Makefile  # Restore previous version
pip install mxmake==<previous-version>  # Downgrade mxmake

Getting Help