Skip to main content

Add commands to simplify release and publish operation from Git CLI.

Project description

Git Improved

Python package to add helpful git commands.

:package: Installation

This package is available from PyPI

It can be installed using

pip install git-improved

:star: Additional commands

git setup

Initialize devops configuration.

  • Create a setup.cfg containing current version, and versioning config.
  • Create a github action to document releases based on changelog.
  • Create docs/changelog.md, and docs/releases/

git wip [category] [description]

Create a branch to work on something.

  • Branch has a category that describe kind of work. (e.g. Feature, CI/CD, Documentation, ...)
  • Description explain what happens on this branch. If not passed, it is prompted.

git done

Merge current branch in main branch.

  • Update [unreleased] section of changelog to reflect changes from current branch
  • Merge current branch into main in a single commit (contains description of squashed commits)

git cancel
  • Without arguments: Delete current branch from local and remote.
  • With -i option: Prompt names of multiple branches to delete

git release [--version VERSION | --patch | --minor | --major]

Deploy a new release for current project.

  • Increment version in all files it is referenced (configure in setup.cfg)
  • Replace [unreleased] section of changelog with new version.
  • Create a file in docs/releases to document this release.

git unrelease [-i] [version]

Delete a release from GitHub.

  • You can pass the version of the release to delete (or a coma separated list of versions)
  • Otherwise, use -i option to be prompted for versions to delete.
  • You can't pass both version and -i flag.

:fire: RoadMap

Must

  • :fire: Handle changelog/squash message generation when more than one section is changed
  • :fire: Add roadmap/assign commands to avoid many people working on same feature
  • Display a warning in save command if working on main branch
    • Propose to create a wip branch from current changes to avoid commiting directly...
    • Add an option to reset X last commits from main, put them on a branch, an perform magic merge.
  • Add an empty github action that run on unrelease. (can be used to remove packages from registries when tag is deleted)

Should

  • Study interesting uses cases of a rollback command that cancel changes introduced by a commit
  • Improve save command by adding an interactive mode to select staged files
  • Add a --no-changelog option to done command that indicates to not update changelog on merge.

Could

  • Define a message syntax that indicates that a commit don't go in changelog (e.g prefix with ;)
  • Require user to be logged into git using a token.
  • Then retrieve author information from github to put in changelog

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

git-improved-0.1.0.tar.gz (16.0 kB view hashes)

Uploaded Source

Built Distribution

git_improved-0.1.0-py3-none-any.whl (20.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page