Migration Guide

This guide helps you upgrade between Jobmon versions.

Note

This page is a placeholder. Content will be added as version migrations are documented.

General Upgrade Process

  1. Read the changelog for breaking changes

  2. Test in development before upgrading production workflows

  3. Update dependencies in your requirements/environment files

  4. Update your code if APIs have changed

Version History

Current Version

Check your installed version:

python -c "import jobmon.client; print(jobmon.client.__version__)"

Changelog

See the full CHANGELOG.md for detailed release notes.

Upgrade Guides

Note

Specific migration guides will be added here as needed. Currently, Jobmon maintains backward compatibility for most common use cases.

Common Migration Issues

Import Path Changes

If imports fail after upgrading, check if paths have changed:

# Old (example)
from jobmon.client.api import Tool

# New (example - check actual current imports)
from jobmon.client.tool import Tool

API Changes

Method signatures occasionally change. Check the API documentation for current signatures.

Configuration Changes

Configuration file format is generally stable. If you encounter issues:

  1. Check the Configuration documentation

  2. Review any deprecation warnings in logs

Getting Help

If you encounter issues during migration:

  1. Check the CHANGELOG for your version

  2. Search GitHub issues for similar problems

  3. Ask for help with your specific error message