| Name | jira2branch JSON |
| Version |
0.5.2
JSON |
| download |
| home_page | |
| Summary | Takes a JIRA issue and creates a git branch |
| upload_time | 2023-10-27 15:17:46 |
| maintainer | |
| docs_url | None |
| author | Tiago Pereira |
| requires_python | >=3.10,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# JIRA 2 Branch
Takes a JIRA issue and creates a git branch
```
Usage: jira2branch [OPTIONS] ISSUE_ID_OR_URL SOURCE_BRANCH
Simple program that takes a JIRA issue ID and creates a new local and
tracking remote branch
Options:
-n, --name-only Generates the branch name and prints it, no actual
branch will be created (default is False)
-p, --push Push newly created branch to remote (default is False)
-t, --target PATH Target repository (default is current directory)
-r, --merge-request Create merge request. Requires --push. (default is False)
-c, --confirm Request confirmation before creating the merge request (default is False)
-d --dry-run Dry run. Prints out the MR payload in JSON format but does not invoke the API
--preview (experimental) This toggles live preview ON when editing a merge request description. Requires vim being set as $EDITOR with markdown-preview.vim plugin installed
--help Show this message and exit.
```
- Branch naming format is as follows:
- {CONVENTIONAL_COMMIT_PREFIX}/{ISSUE_ID}_{ISSUE_TITLE}
## Requirements
Requires Python 3.11
### Dev env
```
pip install poetry
poetry install
pip install dist/jira2branch-[VERSION]-py3-none-any.whl
```
Afterwards, your command should be available:
```
$ jira2branch WT3-227 develop
fix/WT3-227_some-jira-issue
```
### Credentials
#### JIRA
JIRA credentials will be fetched from `[USER HOME]/.j2b/secrets.ini` with the following format:
```ini
[JIRA CREDENTIALS]
# url =
# email =
# username =
# password =
# token =
```
#### Required fields
`url` and `email` are required.
Use either `username` + `password` or `token` depending on how access is configured
#### GitLab
```ini
[GITLAB CREDENTIALS]
# url =
# token =
```
#### Required fields
`token` is required
Set `url` if the GitLab instance you're using is self-hosted
## Usage
`jira2branch [JIRA_ISSUE_ID|JIRA_ISSUE_URL] [TARGET_BRANCH]`
### Examples
`jira2branch WT3-227 main`
`jira2branch https://company.atlassian.net/browse/WT3-227 main`
Raw data
{
"_id": null,
"home_page": "",
"name": "jira2branch",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Tiago Pereira",
"author_email": "tiago@tiagoafpereira.net",
"download_url": "https://files.pythonhosted.org/packages/c8/16/1681af3b6399fca8b5eb2c11e55f7d83492118797862a374e1678b51b384/jira2branch-0.5.2.tar.gz",
"platform": null,
"description": "# JIRA 2 Branch\n\nTakes a JIRA issue and creates a git branch\n\n```\nUsage: jira2branch [OPTIONS] ISSUE_ID_OR_URL SOURCE_BRANCH\n\n Simple program that takes a JIRA issue ID and creates a new local and\n tracking remote branch\n\nOptions:\n -n, --name-only Generates the branch name and prints it, no actual\n branch will be created (default is False)\n -p, --push Push newly created branch to remote (default is False)\n -t, --target PATH Target repository (default is current directory)\n -r, --merge-request Create merge request. Requires --push. (default is False)\n -c, --confirm Request confirmation before creating the merge request (default is False)\n -d --dry-run Dry run. Prints out the MR payload in JSON format but does not invoke the API \n \n --preview (experimental) This toggles live preview ON when editing a merge request description. Requires vim being set as $EDITOR with markdown-preview.vim plugin installed\n\n --help Show this message and exit.\n```\n\n- Branch naming format is as follows:\n - {CONVENTIONAL_COMMIT_PREFIX}/{ISSUE_ID}_{ISSUE_TITLE}\n\n## Requirements\n\nRequires Python 3.11\n\n### Dev env\n\n```\npip install poetry\npoetry install\npip install dist/jira2branch-[VERSION]-py3-none-any.whl\n```\n\nAfterwards, your command should be available:\n\n```\n$ jira2branch WT3-227 develop\nfix/WT3-227_some-jira-issue\n```\n\n### Credentials\n\n#### JIRA\n\nJIRA credentials will be fetched from `[USER HOME]/.j2b/secrets.ini` with the following format:\n\n```ini\n[JIRA CREDENTIALS]\n\n# url = \n# email = \n# username = \n# password = \n# token = \n```\n\n#### Required fields\n\n`url` and `email` are required.\n\nUse either `username` + `password` or `token` depending on how access is configured\n\n#### GitLab\n\n```ini\n[GITLAB CREDENTIALS]\n\n# url = \n# token = \n```\n\n#### Required fields\n\n`token` is required\n\nSet `url` if the GitLab instance you're using is self-hosted\n\n## Usage\n\n`jira2branch [JIRA_ISSUE_ID|JIRA_ISSUE_URL] [TARGET_BRANCH]`\n\n### Examples\n\n`jira2branch WT3-227 main`\n\n`jira2branch https://company.atlassian.net/browse/WT3-227 main`\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Takes a JIRA issue and creates a git branch",
"version": "0.5.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b40ea1fef4d0fb18d63d927085b22f7c824019ab0f97f1b1977103227bc51b04",
"md5": "8e1015975dcf206f64c5e2505a3938c9",
"sha256": "7e2fe721269964377c3d2c028299b113d7e3cd1fb41d969aa16c8f4882b95255"
},
"downloads": -1,
"filename": "jira2branch-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8e1015975dcf206f64c5e2505a3938c9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 10602,
"upload_time": "2023-10-27T15:17:45",
"upload_time_iso_8601": "2023-10-27T15:17:45.224949Z",
"url": "https://files.pythonhosted.org/packages/b4/0e/a1fef4d0fb18d63d927085b22f7c824019ab0f97f1b1977103227bc51b04/jira2branch-0.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c8161681af3b6399fca8b5eb2c11e55f7d83492118797862a374e1678b51b384",
"md5": "c99d2dd116a26851de724f623d2dc797",
"sha256": "fe6fe3bd0cbdcad53b607ee44d5fc207879ec1429c20db64a1672d169a4c4e62"
},
"downloads": -1,
"filename": "jira2branch-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "c99d2dd116a26851de724f623d2dc797",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 9875,
"upload_time": "2023-10-27T15:17:46",
"upload_time_iso_8601": "2023-10-27T15:17:46.927313Z",
"url": "https://files.pythonhosted.org/packages/c8/16/1681af3b6399fca8b5eb2c11e55f7d83492118797862a374e1678b51b384/jira2branch-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-27 15:17:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "jira2branch"
}
