colophon propose¶
Description¶
Write the release branch and open or update its merge request
Re-cut the release branch from its target, write the changelog into it, and open or update the merge request that proposes the release. The branch is cut from the target on every run rather than kept up to date with it, so the merge request can never be behind. Nothing is tagged and nothing is published; that is `publish`. A repository with nothing to release, or one holding releases, reports so and exits zero.
Usage¶
Run colophon propose --help for the authoritative, always-current flag set.
Flags¶
| Flag | Description | Default |
|---|---|---|
--author-email |
Email on the release commit | [email protected] |
--author-name |
Name on the release commit | colophon |
--branch |
Release branch to write | derived: colophon/release/<target> |
--dry-run |
Print the merge request that would be opened, and write nothing | false |
--remote |
Git remote to read and push to | origin |
-C, --repo |
Path to the git repository | . |
--target |
Branch to release from | main |
Needs a forge token in <FORGE>_TOKEN. See the
configuration reference.
Global flags¶
| Flag | Description | Default |
|---|---|---|
--ci |
Indicates the tool is running in a CI environment | false |
--config |
Config files to use (repeatable) | /etc/colophon/config.yaml, ~/.colophon/config.yaml |
--debug |
Force debug log output | false |
--output |
Output format: text or json |
text |
Run colophon <command> --help for the authoritative, always-current flag set.