This tool is not complete, and not yet intended for use!!
A tool to create and manage releases in Jira based on Git commit history.
TBD
You must include a config file.
Add a file named Config.toml in a directory named jira-release-helper in the traditional config directory for your operating system (as defined by the dirs Rust crate).
| Platform | Value | Example |
|---|---|---|
| Linux | $XDG_CONFIG_HOME or $HOME/.config/jira-release-helper/Config.toml |
/home/alice/.config/jira-release-helper/Config.toml |
| macOS | $HOME/Library/Application Support/jira-release-helper/Config.toml |
/Users/Alice/Library/Application Support/jira-release-helper/Config.toml |
| Windows | {FOLDERID_RoamingAppData}/jira-release-helper/Config.toml |
C:\Users\Alice\AppData\Roaming\jira-release-helper\Config.toml |
The file should contain an array of repositories to check written in toml.
Example:
[[repositories]]
label = "First Repository"
location = "/Users/amjerm/code/first-repo"
project_key = "TI"
release_branch = "custom-branch-name"
[[repositories]]
label = "Second"
location = "/Users/amjerm/code/second"
project_key = "TI"
[[repositories]]
label = "Another"
location = "/Users/amjerm/code/another-repo"
project_key = "TI"Fields
label - Name to use for the repository in output
location - Path to the repository
project_key - Jira project key (i.e. "TI" if your tickets are "TI-123")
release_branch (optional) - Override default release branch name to check for tickets (default: "release")
# Run all repositories in the config file
./jira_release_helper
# Run specific repositories
./jira_release_helper --list First\ Repository,Another