README

Bidla is a PHP Tool for help developers to generates Changelog and Contributors files. Bidla reads your VCS log and generates a changelog/contributors file to include in your repository.

INSTALLATION

Locally

Download the bidla.phar file and store it somewhere on your computer.

Globally (manual)

You can run these commands to easily access bidla.phar from anywhere on your system:

$ wget http://gesdinet.github.io/bidla/download/bidla.phar -O bidla

or with curl:

$ curl http://gesdinet.github.io/bidla/download/bidla.phar -o bidla

$ sudo chmod a+x bidla
$ sudo mv bidla /usr/local/bin/bidla

Then, just run bidla

Globally (composer)

To install bidla, install Composer and issue the following command:

$ ./composer.phar global require gesdinet/bidla

Then, make sure you have ~/.composer/vendor/bin in your PATH, and you're good to go:

export PATH="$PATH:$HOME/.composer/vendor/bin"

Then, just run bidla

Use

In this early release Bidla only supports Git and Markdown:

These commands puts by default git, markdown, and CHANGELOG.md or CONTRIBUTORS.md

bidla changelog
bidla contributors

Bidla changelog is going to ask you for the next tag release name. This happens cause if you tag before generate CHANGELOG then CHANGELOG file not be included in release and if you tag after Bidla can´t read last tag name.

Workflow is:

First commit all changes for release
Generate CHANGELOG and CONTRIBUTORS files with next tag name and commit them
Tag your release
Push your changes to remote

Optional arguments

Bidla accepts three input arguments

bidla [vcs] [file] [filename]

###Note

Actually bidla only supports git and markdown

UPDATE

Locally (actually doesn´t work, need to re-download .phar)

The self-update command tries to update bidla itself:

$ bidla.phar update

Globally (manual) (actually doesn´t work, need to re-download .phar)

You can update bidla through this command:

$ sudo bidla update

Globally (Composer)

You can update bidla through this command:

$ ./composer.phar global update gesdinet/bidla

Example output

This project CHANGELOG.md and CONTRIBUTORS.md

How to Collaborate in this Project

Feel free to open issues

LEGAL DISCLAIMER

This software is published under the MIT License, which states that:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

gesdinet / bidla

Maintainers

Details