tickets-since
v1.0.2
Published
A lightweight CLI tool to extract Jira/issue ticket IDs from git commit messages, supporting commits since a specific tag, hash, or date.
Maintainers
Readme
tickets-since
A lightweight CLI tool that extracts ticket IDs from git commit messages, supporting commits since a specific tag, commit hash, or date.
This tool is useful for generating release notes, changelogs, or automating reporting of Jira/issue tickets.
Features
- Extract ticket IDs from commit messages in the format:
fix(TICKET-1234): description - Support commits:
- Since a specific git tag
- Since the latest git tag
- Since a specific commit hash
- Since a specific date
- Supports multiple tickets per commit
(TICKET-1,TICKET-2) - Interactive CLI prompts when parameters are missing
- Quit the prompt anytime with
q
Installation
Install globally via npm:
npm install -g tickets-sinceor localy
git clone <repo-url>
cd tickets-since
npm install
npm link # for local testingCommit Message Format (Important)
Ensure your commit messages include ticket IDs in the following format:
<type>(TICKET-1234,TICKET-5678): commit descriptionExamples:
fix(INDIA-25975,INDIA-122131): update video URL validation to use YouTube validationfeat(COMMONWEB-30000): add new feature to improve user experience
Usage
tickets-since [options]Options
| Option | Description |
|--------------------------|-----------------------------------------------------------------------------------------------|
| -t, --since-tag [tags] | Fetch tickets from commits since a specific git tag or between two tags (format: tag1,tag2) |
| -l, --since-latest-tag | Fetch tickets from commits since the latest git tag |
| -d, --since-date [date] | Fetch tickets from commits since a specific date (YYYY-MM-DD) |
| -h, --since-hash [hash] | Fetch tickets from commits since a specific git commit hash |
| -v, --version | Display version information |
Examples:
- Since a specific tag:
tickets-since --since-tag v1.0.0 - Between two tags:
tickets-since --since-tag v1.0.0,v1.1.0 - Since the latest tag:
tickets-since --since-latest-tag - Since a specific date:
tickets-since --since-date 2023-01-01 - Since a specific commit hash:
tickets-since --since-hash abc1234
Interactive Mode
If no options are provided, the tool will prompt you to select an action and provide necessary details.
Press q at any prompt to exit.
License
This project is licensed under the MIT License.
Contributing
Contributions are welcome! Please open issues or submit pull requests for improvements or bug fixes.
