README

Laravel Git Toolkit is a simple package that integrates Git operations within your Laravel projects. It provides commands to help manage Git workflows more efficiently, such as initializing Git flow branches, committing changes, and other Git-related tasks.

Installation

You can install the package via Composer:

composer require ahmedessam/laravel-git-toolkit

You can publish the configuration file with:

php artisan vendor:publish --tag=git-toolkit-config

Environment Variables

The package uses the following environment variables:

GIT_PUSH_TO_DEFAULT_BRANCH - Whether to push changes to the default branch. Default is false.
GIT_DEFAULT_BRANCH - The default branch to push changes to. Default is current.
GIT_PUSH_WITH_DEFAULT_MESSAGE - Whether to push changes with the default commit message. Default is false.
GIT_DEFAULT_COMMIT_TYPE - The default commit type. Default is feat.
GIT_DEFAULT_COMMIT_MESSAGE - The default commit message. Default is Update [%s] branch with latest changes..
GIT_PUSH_AFTER_COMMIT - Whether to push changes after committing. Default is true.
GIT_RETURN_TO_PREVIOUS_BRANCH - Whether to return to the previous branch after committing. Default is true.
GIT_DELETE_AFTER_MERGE - Whether to delete the merged branch after merging. Default is false.
GIT_FLOW_ENABLED - Whether to enable Git flow branches. Default is true.

You can add these environment variables to your .env file.

copy the following code to your .env file:

GIT_PUSH_TO_DEFAULT_BRANCH=false
GIT_DEFAULT_BRANCH='current'
GIT_PUSH_WITH_DEFAULT_MESSAGE=false
GIT_DEFAULT_COMMIT_TYPE='feat'
GIT_DEFAULT_COMMIT_MESSAGE='Update [%s] branch with latest changes.'
GIT_PUSH_AFTER_COMMIT=true
GIT_RETURN_TO_PREVIOUS_BRANCH=true
GIT_DELETE_AFTER_MERGE=false
GIT_FLOW_ENABLED=true

Notes

The package uses the git command to perform Git operations.
The package asks few questions to get the required data to perform the operation.
The package provides a list of flags to specify the required data to perform the operation.
The package uses the following flags:
- --branch flag to specify the branch name.
- --message flag to specify the commit message.
- --type flag to specify the commit type.
- --merge flag to specify the branch to merge.
- --return flag to specify whether to return to the previous branch.
- --commit flag to specify the commit hash to reset to.

Usage

To initialize git flow branches, run the following command:

php artisan git:flow

This command will create the following main branches:

main
develop
staging
hotfix

You can also create feature, fix, and release branches, package ask for theses branches names.

To commit changes, run the following command:

php artisan git push

This command will add all changes, commit them, and push them to the current branch.

To create a new branch, run the following command:

php artisan git branch

This command will create a new branch based on the type you choose.

To pull changes from the remote repository, run the following command:

php artisan git pull

This command will pull changes from the remote repository to the current branch or the branch you specify.

To merge branches, run the following command:

php artisan git merge --merge=<source-branch> --branch=<target-branch>

Flags

--merge flag to specify the branch to merge from.
--branch flag to specify the branch or branches sperated by comma or space to merge into.
ex: php artisan git merge --merge=feature --branch=develop,main

This command will merge the specified branch into the branch you specify.

To delete a branch, run the following command:

php artisan git delete-branch

This command will delete the specified branch.

To Push new branch to remote repository, run the following command:

php artisan git push-branch

To Fetch changes from the remote repository, run the following command:

php artisan git fetch

This command will fetch changes from the remote repository.

To Rebase changes from the remote repository, run the following command:

php artisan git rebase

This command will rebase changes from the remote repository.

To Reset changes from the remote repository, run the following command:

php artisan git reset --commit=<commit-hash>

This command will reset changes from the remote repository.

Features

Initialize Git flow branches
Commit changes and push them to the current branch
Create branches for features, fixes, releases, hotfixes or other custom branches
Pull changes from the remote repository
Merge branches
Delete branches
Push new branch to remote repository
Fetch changes from the remote repository
Rebase changes from the remote repository
Reset changes from the remote repository

Requirements

Git should be installed on your machine
You should have a remote repository set up
You should have SSH keys set up for your remote repository
You should have a Laravel project set up
You should have a basic understanding of Git

License

The Laravel Git Toolkit is open-sourced software licensed under the MIT license.

Author

Ahmed Essam

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Issues

If you find any issues with the package or have any questions, please feel free to open an issue on the GitHub repository.

Enjoy using Laravel Git Toolkit! 🚀

ahmedessam / laravel-git-toolkit

Maintainers

Details