BIDLA
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., (*1)
INSTALLATION
Locally
Download the bidla.phar file and store it somewhere on your computer., (*2)
Globally (manual)
You can run these commands to easily access bidla.phar from anywhere on
your system:, (*3)
$ wget http://gesdinet.github.io/bidla/download/bidla.phar -O bidla
or with curl:, (*4)
$ 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, (*5)
Globally (composer)
To install bidla, install Composer and issue the following command:, (*6)
$ ./composer.phar global require gesdinet/bidla
Then, make sure you have ~/.composer/vendor/bin in your PATH, and
you're good to go:, (*7)
export PATH="$PATH:$HOME/.composer/vendor/bin"
Then, just run bidla, (*8)
Use
In this early release Bidla only supports Git and Markdown:, (*9)
These commands puts by default git, markdown, and CHANGELOG.md or CONTRIBUTORS.md, (*10)
- 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., (*11)
Workflow is:, (*12)
- 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, (*13)
- bidla [vcs] [file] [filename]
Note
Actually bidla only supports git and markdown, (*14)
UPDATE
Locally (actually doesn´t work, need to re-download .phar)
The self-update command tries to update bidla itself:, (*15)
$ bidla.phar update
Globally (manual) (actually doesn´t work, need to re-download .phar)
You can update bidla through this command:, (*16)
$ sudo bidla update, (*17)
Globally (Composer)
You can update bidla through this command:, (*18)
$ ./composer.phar global update gesdinet/bidla, (*19)
Example output
This project CHANGELOG.md and CONTRIBUTORS.md, (*20)
How to Collaborate in this Project
Feel free to open issues, (*21)
LEGAL DISCLAIMER
This software is published under the MIT License, which states that:, (*22)
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., (*23)
Wallogit.com
