Galaxy Release Utility

0.3.2 verified Fri May 01 auth: no python

Utility for various tasks around creating Galaxy releases. Currently at version 0.3.2, with Python >=3.8 required. Maintained by the Galaxy Project; release cadence is irregular.

pip install galaxy-release-util

Common errors

error ModuleNotFoundError: No module named 'galaxy-release-util' ↓

cause Attempting to import using hyphens (Python package names use underscores).

fix

Use from galaxy_release_util import ... instead of galaxy-release-util.

error AttributeError: module 'galaxy_release_util' has no attribute 'create_point_release' ↓

cause Importing the top-level module instead of the specific submodule.

fix

Use from galaxy_release_util.create_point_release import create_point_release.

error TypeError: create_point_release() got an unexpected keyword argument 'dry_run' ↓

cause The `dry_run` parameter was removed in version 0.3.0.

fix

Remove dry_run from the call. If you need a dry run, implement your own logic.

Warnings

gotcha The GitHub token must have appropriate permissions (repo scope) to create releases and issues. Without a token with sufficient rights, release creation will fail with a 403 error. ↓

fix Set the GITHUB_TOKEN environment variable or pass it explicitly. Token must have 'repo' scope.

breaking In version 0.3.0, the signature of `create_point_release` changed; the `dry_run` parameter was removed. Code relying on dry_run will break. ↓

fix Remove the `dry_run` argument from calls; use conditional logic if needed.

gotcha The package uses underscores in module names (e.g., `create_point_release`). When importing, replace hyphens with underscores. Common mistake: `from galaxy-release-util import ...` which is invalid syntax. ↓

fix Use underscores in imports: `from galaxy_release_util import ...`

Imports

create_point_release

from galaxy_release_util.create_point_release import create_point_release

Correct import path for point release creation.

bootstrap_history

from galaxy_release_util.bootstrap_history import bootstrap_history

Correct import for bootstrapping history.

Quickstart

Create a point release for Galaxy version 22.01 to 22.01.1 using a GitHub token from environment.

from galaxy_release_util.create_point_release import create_point_release
create_point_release('22.01', '22.01.1', github_token=os.environ.get('GITHUB_TOKEN', ''))