git_changie 0.0.2 copy "git_changie: ^0.0.2" to clipboard
git_changie: ^0.0.2 copied to clipboard

A changelog generator for github.

git_changie πŸŽ‰ #

git_changie is a powerful Dart command-line tool designed to simplify the generation of changelogs from Git commit messages while promoting a standardized commit message format. πŸš€

Features πŸš€ #

General Features 🌟 #

  • Changelog Generation: Automatically generates a changelog from Git commit messages.
  • Output File Customization: Specify the output file name (default: CHANGELOG.md).
  • Backup Existing Changelog: Automatically creates a backup of the existing changelog file before overwriting it.

Command-Line Options πŸ“œ #

  • --hash: Include commit hash in the changelog.
  • --author: Include commit author in the changelog.
  • --date: Include commit date in the changelog.
  • --from-tag <tag>: Generate changelog starting from a specific Git tag.
  • --to-tag <tag>: Generate changelog up to a specific Git tag (inclusive).
  • --since <date>: Generate changelog starting from a specific date (format: YYYY-MM-DD).
  • --until <date>: Generate changelog up to a specific date (format: YYYY-MM-DD).
  • --output <file>: Specify the output file name (default: CHANGELOG.md).
  • --add-category <name>: Add a custom category for commit messages if needed.
  • --help: Show help message with usage instructions.

Emoji Categorization 😊 #

  • Supports a variety of emoji categories for better organization of commit messages, including:
    • 🎨 Style
    • ⚑️ Performance
    • πŸ”₯ Remove
    • πŸ› Fixes
    • πŸš‘ Critical Hotfix
    • ✨ Features
    • πŸ“ Documentation
    • πŸš€ Deployment
    • πŸ’„ UI Changes
    • πŸŽ‰ Initial Commit
    • βœ… Tests
    • πŸ”’οΈ Security
    • πŸ” Secrets
    • πŸ”– Release Tags
    • 🚨 Warnings
    • 🚧 Work In Progress
    • πŸ’š CI Build
    • ⬇️ Downgrade
    • ⬆️ Upgrade
    • πŸ“Œ Pin Dependencies
    • πŸ‘· CI System
    • πŸ“ˆ Analytics
    • ♻️ Refactor
    • βž• Add Dependency
    • βž– Remove Dependency
    • πŸ”§ Configuration
    • πŸ”¨ Development Scripts
    • 🌐 Internationalization
    • ✏️ Typos
    • πŸ’© Bad Code
    • βͺ Revert
    • πŸ”€ Merge
    • πŸ“¦ Compiled Files
    • πŸ‘½οΈ API Changes
    • 🚚 Move/Rename Resources
    • πŸ“„ License
    • πŸ’₯ Breaking Changes
    • 🍱 Assets
    • ♿️ Accessibility
    • πŸ’‘ Comments
    • 🍻 Drunken Code
    • πŸ’¬ Text Changes
    • πŸ—ƒοΈ Database Changes
    • πŸ”Š Logs
    • πŸ”‡ Remove Logs
    • πŸ‘₯ Contributors
    • 🚸 User Experience
    • πŸ—οΈ Architectural Changes
    • πŸ“± Responsive Design
    • 🀑 Mocking
    • πŸ₯š Easter Eggs
    • πŸ™ˆ .gitignore
    • πŸ“Έ Snapshots
    • βš—οΈ Experiments
    • πŸ” SEO
    • 🏷️ Types
    • 🌱 Seed Files
    • 🚩 Feature Flags
    • πŸ₯… Catch Errors
    • πŸ’« Animations
    • πŸ—‘οΈ Deprecate Code
    • πŸ›‚ Authorization
    • 🩹 Minor Fixes
    • 🧐 Data Inspection
    • ⚰️ Remove Dead Code
    • πŸ§ͺ Failing Test
    • πŸ‘” Business Logic
    • 🩺 Healthcheck
    • 🧱 Infrastructure
    • πŸ§‘β€πŸ’» Dev Experience
    • πŸ’Έ Sponsorships
    • 🧡 Multithreading
    • 🦺 Validation

With git_changie, you can effortlessly track and categorize changes in your project, making collaboration smoother and more organized! 🌈

Installation #

From GitHub #

You can clone the repository and build it locally:

git clone https://github.com/Shreemanarjun/git_changie.git
cd git_changie
dart pub get

Activate Globally from pub.flutter-io.cn #

Run

dart pub global activate git_changie 

To generate CHANGELOG.MD

git_changie

First-Class Support with Gitmoji Plugin for VS Code #

For a more visually appealing commit message experience, you can integrate the Gitmoji plugin for Visual Studio Code. This plugin provides a list of emojis to choose from, helping you maintain consistency in your commit messages.

To install the Gitmoji extension:

  1. Open VS Code.
  2. Go to Extensions (Ctrl+Shift+X).
  3. Search for "Gitmoji" and install it.
  4. Follow the extension's instructions to start using Gitmoji in your commit messages.

Usage #

Run the git_changie command in your terminal with various options to customize the output. Here are some common usages:

Basic Command #

To generate a changelog from your Git commits:

git_changie

Include Commit Hash, Author, and Date #

You can include the commit hash, author, and date in your changelog:

git_changie --hash --author --date

Filter by Tags #

Generate a changelog starting from a specific tag:

git_changie --from-tag v1.0.0

Or up to a specific tag:

git_changie --to-tag v2.0.0

Filter by Date #

You can filter commits by date ranges:

git_changie --since 2024-01-01 --until 2024-09-30

Specify Output File #

To specify a custom output file for the changelog:

git_changie --output my_changelog.md

Add Custom Categories #

You can add custom categories for your changelog entries:

git_changie --add-category "Custom Category"

Help Command #

For a full list of options, run:

git_changie --help

Contributing #

Feel free to submit issues, pull requests, or suggestions.

License #

This project is licensed under the MIT License. See the LICENSE file for more details.

3
likes
135
points
26
downloads

Publisher

verified publishershreeman.dev

Weekly Downloads

A changelog generator for github.

Repository (GitHub)
View/report issues
Contributing

Documentation

API reference

License

MIT (license)

Dependencies

args, pubspec_yaml

More

Packages that depend on git_changie