gitcd

Name	gitcd JSON
Version	2.2.9 JSON
	download
home_page	https://www.gitcd.io
Summary	Tool for continuous delivery using git
upload_time	2025-11-01 13:29:29
maintainer	None
docs_url	None
author	Claudio Walser
requires_python	>=3.9
license	Apache License
keywords	git application continuos delivery
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

Continuous tool for working with git
====================================

.. image:: https://www.gitcd.io/images/logo.svg
:height: 150px
:width: 150px

**Development Status**

.. image:: https://img.shields.io/pypi/status/gitcd.svg
:target: https://pypi.org/project/gitcd/

.. image:: https://travis-ci.org/gitcd-io/gitcd.svg?branch=master
:target: https://travis-ci.org/gitcd-io/gitcd

.. image:: https://readthedocs.org/projects/gitcd/badge/?version=latest
:target: https://gitcd.readthedocs.org/en/latest/?badge=latest

.. image:: https://img.shields.io/github/last-commit/gitcd-io/gitcd.svg
:target: https://github.com/gitcd-io/gitcd/commits/master

**Package Info**

.. image:: https://badge.fury.io/py/gitcd.svg
:target: https://pypi.org/project/gitcd/

.. image:: https://img.shields.io/pypi/dm/gitcd.svg
:target: https://pypi.org/project/gitcd/

.. image:: https://img.shields.io/pypi/wheel/gitcd.svg
:target: https://pypi.org/project/gitcd/

.. image:: http://img.shields.io/badge/license-APACHE2-blue.svg
:target: https://github.com/gitcd-io/gitcd/blob/master/LICENSE

.. image:: https://img.shields.io/pypi/pyversions/gitcd.svg
:target: https://pypi.org/project/gitcd/

Description
###########

**gitcd** is a little helper for continuous delivery workflows, using git as scm.

Installation of gitcd
#####################

Pre requisites
--------------
Gitcd is written in Python3. Most systems still deliver with Python2 as default.
You need to install Python3 in order to run gitcd properly.

MacOSX
______

.. code-block:: bash

brew install python3

Ubuntu / Debian
_______________

.. code-block:: bash

sudo apt-get install python3 python3-pip

Installation of gitcd itself
----------------------------
Now you are ready to install gitcd itself, which is quite easy using pip.

.. code-block:: bash

pip3 install --user --upgrade gitcd

Trouble using git-cd?
---------------------
If the command "git-cd" or "git cd" is not available now, you probably need to add the pip binary path to your $PATH variable.

MacOSX
______

Open ~/.bash_profile or ~/.zprofile in your favorite editor and add the following lines at the end of the file.

.. note::

Replace <python-version> with your currently installed python version, e.g. ``3.11``

.. code-block:: bash

if [ -d "$HOME/Library/Python/<python-version>/bin" ] ; then
PATH="$HOME/Library/Python/<python-version>/bin:$PATH"
fi

Ubuntu / Debian
_______________

Open ~/.profile in your favorite editor and add the following lines at the end of the file.

.. code-block:: bash

if [ -d "$HOME/.local/bin" ] ; then
PATH="$HOME/.local/bin:$PATH"
fi

Argument Completion
-------------------
Gitcd supports argument completion, to activate it execute the following steps.

MacOSX
______

Under OSX it isn't that simple unfortunately. Global completion requires bash support for complete -D, which was introduced in bash 4.2. On OS X or older Linux systems, you will need to update bash to use this feature. Check the version of the running copy of bash with echo $BASH_VERSION. On OS X, install bash via Homebrew (brew install bash), add /usr/local/bin/bash to /etc/shells, and run chsh to change your shell.

You might consider reading the docs for argcomplete https://argcomplete.readthedocs.io/en/latest/#global-completion

Activate Global argcomplete
_____________________________

You are now ready to activate global argcompletion for python with the following command.

.. code-block:: bash

activate-global-python-argcomplete

CLI Usage of gitcd
##################

For convenience, you can call gitcd as a git sub command as well as directly. Therefore, you can replace "git cd" in any of the following commands with "git-cd" if you like it more.

.. note::

Python argument completion won't work if you use it as a git sub command!

Initializing gitcd
------------------
First of all you probably want to initialize one of your local git repositories with gitcd. Change directory to one of your local git repositories and run git-cd init.
Most of the values should be very self-explanatory. Still, here is a complete list of values you can pass.

- **Branch name for production releases?**

- This is the branch git-cd is creating a tag from if you execute the release command, you probably want to go with **master** here.

- **Branch name for feature development?**

- This is more kind of a prefix for feature branches, it is empty by default. If you wish your feature branch has a name like feature/my-new-feature, you can set this prefix to **feature/**.

- **Branch name for test releases?**

- Pass your branch name where you want to merge code into while executing git-cd test. Let it empty if you don't want to use that feature. At work, we have this for many repositories set to **test**.

- **Version tag prefix?**

- Prefix for your release tags, this is **v** by default which would result in a tag equals to v0.0.1 for example.

- **Version type? You can either set your tag number manually, read it from a version file or generate it by date.**

- This is about how git-cd release gets your current version number you want to release.

- manual means you'll get asked to enter the version number by hand
- file means gitcd reads the version number from a file, you'll be asked from which file in the next step
- date means you generate a version number from a date scheme, you'll be asked for the scheme later. As a date version scheme, you can pass any directive for http://strftime.org/.

- **Do you want to execute some additional commands after a release?**

- This is useful if you want to execute any cli script after creating a tag, for example, gitcd itself uses such a script to publish the new release on pypi after creating a new tag. You can see the script here https://github.com/gitcd-io/gitcd/blob/master/publish.sh.

- **Do you want to execute some additional commands before a release?**

- This is useful if you want to execute any cli script before creating a tag, for example, if you want to modify any file in your git tree where you want to add the current version number.

.. code-block:: bash

git cd init

The image below represents the configuration for gitcd itself.