README

Installation

composer global require ibrostudio/gitbro

Configuration

To communicate with Github, you need to register in the config a Github Personal Access Token:

gitbro config

Init a new project

gitbro init

This will create a new Github repository, following your parameters, as visibility or ownership, and then clone it locally.

Using templates repositories

You can use a template for your project. By default, Spatie Package Skeleton Laravel and Filament PHP Plugin Skeleton are available, but you can add more using the following command:

gitbro template

Conventional Commits

This app follows the Conventional Commits specification. A commit type will prefix your message to help history comprehension and will be used by the CHANGELOG generator.

gitbro commit

Running scripts before commit

You can automatically run tests or format code scripts before each commit:

Create a gitbro.neon file at the root of your project with:

scripts:
    format-code:
        - 'vendor/bin/pint'
        - 'npx prettier . --write'
    test-code:
        - 'composer test'

Pull, push, sync

gibro pull for git pull origin main --rebase
gibro push for git push origin main
gibro sync will execute gitbro pull and then gitbro push

Releases

You can easily perform a release creation by running:

gitbro release

This will:

define the version, following the semantic versionning
bump the new version in composer.json and/or package.json if used
generate a note section in your CHANGELOG
create the release on Github

Testing

composer test

ibrostudio / gitbro

Maintainers

Details