{"id":13689201,"url":"https://github.com/milin/giticket","last_synced_at":"2025-05-01T23:32:52.850Z","repository":{"id":46084307,"uuid":"163879686","full_name":"milin/giticket","owner":"milin","description":"Utility to autoadd ticket number specified in your branch name to your commits!","archived":false,"fork":false,"pushed_at":"2023-09-30T08:30:42.000Z","size":71,"stargazers_count":78,"open_issues_count":6,"forks_count":16,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-02T19:38:01.801Z","etag":null,"topics":["agile","commits","git","jira","precommit","tickets"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/milin.png","metadata":{"files":{"readme":"README.rst","changelog":"HISTORY.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-02T19:12:49.000Z","updated_at":"2024-09-22T20:17:06.000Z","dependencies_parsed_at":"2023-01-31T01:30:49.550Z","dependency_job_id":null,"html_url":"https://github.com/milin/giticket","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/milin%2Fgiticket","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/milin%2Fgiticket/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/milin%2Fgiticket/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/milin%2Fgiticket/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/milin","download_url":"https://codeload.github.com/milin/giticket/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224282180,"owners_count":17285784,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agile","commits","git","jira","precommit","tickets"],"created_at":"2024-08-02T15:01:37.870Z","updated_at":"2024-11-12T13:31:03.650Z","avatar_url":"https://github.com/milin.png","language":"Python","readme":"========\ngiticket\n========\n\n.. image:: https://api.star-history.com/svg?repos=milin/giticket\u0026type=Date)](https://star-history.com/#milin/giticket\u0026Date\n\n.. image:: https://img.shields.io/pypi/v/giticket.svg\n        :target: https://pypi.python.org/pypi/giticket\n\n.. image:: https://travis-ci.com/milin/giticket.svg?branch=master\n        :target: https://travis-ci.org/milin/giticket\n\n.. image:: https://readthedocs.org/projects/giticket/badge/?version=latest\n        :target: https://giticket.readthedocs.io/en/latest/?badge=latest\n        :alt: Documentation Status\n\n\n\n\nAuto add ticket info to your git commits.\n\n\n* Free software: MIT license\n* Documentation: https://giticket.readthedocs.io.\n\n\nFeatures\n--------\n\nThis hook saves developers time by prepending ticket numbers to commit-msgs.\nFor this to work the following two conditions must be met:\n   - The ticket format regex specified must match, if the regex is passed in.\n   - Unless you use ``regex_match`` mode, the branch name format must be \u003cticket number\u003e_\u003crest of the branch name\u003e\n\nFor e.g. if you name your branch ``JIRA-1234_awesome_feature`` and commit ``Fix some bug``, the commit will be updated to ``JIRA-1234 Fix some bug``.\n\nPass ``--regex=`` or update ``args: [--regex=\u003ccustom regex\u003e]`` in your .yaml file if you have custom ticket regex.\nBy default it's ``[A-Z]+-\\d+``.\n\nPass ``--format=`` or update ``args: [--format=\u003ccustom template string\u003e]`` in your .yaml file if you have custom message replacement.\nBy default it's ``'{ticket} {commit_msg}``, where ``ticket`` is replaced with the found ticket number and ``commit_msg`` is replaced with the original commit message.\n\nPass ``--mode=`` or update ``args: [--mode=regex_match]`` in your .yaml file to extract ticket by the regex rather than relying on branch name convention.\nWith this mode you can also make use of ``{tickets}`` placeholder in ``format`` argument value to put multiple comma-separated tickets in the commit message in case your branch contains more than one ticket.\n\nIt is best used along with pre-commit_. You can use it along with pre-commit by adding the following hook in your ``.pre-commit-config.yaml`` file.\n\n::\n\n    repos:\n    - repo:  https://github.com/milin/giticket\n      rev: v1.3\n      hooks:\n      - id:  giticket\n        args: ['--regex=PROJ-[0-9]', '--format={ticket} {commit_msg}']  # Optional\n\n\nYou need to have precommit setup to use this hook.\n--------------------------------------------------\n   Install Pre-commit and the commit-msg hook-type.\n\n\n   ::\n\n        pip install pre-commit\n        pre-commit install\n        pre-commit install --hook-type commit-msg\n\n\n.. _pre-commit: https://pre-commit.com/\n","funding_links":[],"categories":["git"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmilin%2Fgiticket","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmilin%2Fgiticket","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmilin%2Fgiticket/lists"}