release¶
Create maintenance releases for repositories with merged dependency PRs.
Usage¶
Examples¶
# Dry-run (default)
versionconductor release --orgs myorg
# Create releases
versionconductor release --orgs myorg --execute
# Only PRs merged since a date
versionconductor release --orgs myorg --since 2025-01-01 --execute
# Create as drafts for review
versionconductor release --orgs myorg --draft --execute
# Custom version prefix
versionconductor release --orgs myorg --prefix "" --execute # No prefix
Flags¶
| Flag | Default | Description |
|---|---|---|
--orgs |
Organizations to scan | |
--repos |
Specific repos (owner/name) | |
--execute |
false |
Actually create releases (default: dry-run) |
--since |
Only PRs merged since date (YYYY-MM-DD) | |
--draft |
false |
Create as draft releases |
--prerelease |
false |
Mark releases as prereleases |
--prefix |
v |
Version prefix |
--generate-notes |
true |
Use GitHub's auto-generated release notes |
--min-prs |
1 |
Minimum number of merged PRs to trigger a release |
--max-releases |
0 |
Maximum number of releases to create (0 = no limit) |
--format |
table |
Output format |
Version Bumping¶
VersionConductor automatically determines the version bump:
| Change Type | Version Bump |
|---|---|
| Dependency patches | Patch (1.2.3 → 1.2.4) |
| Dependency minors | Patch (1.2.3 → 1.2.4) |
| Multiple updates | Patch (1.2.3 → 1.2.4) |
Dependency updates always result in patch releases. Use manual releases for minor/major version bumps.
Release Notes¶
Auto-generated release notes include:
- List of merged dependency PRs
- Link to each PR
- Dependency name and version change