GitlabReleaseNoteGenerator

Description

This gem helps you to create release notes.

Installation

Add this line to your application's Gemfile:

gem 'gitlab_release_note_generator'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install gitlab_release_note_generator

Run this script in your console:

echo "function generate_release_notes() {    
    PATH_TO_RELEASE_NOTE_GENERATOR=`gem which gitlab_release_note_generator`;
    ruby "$"PATH_TO_RELEASE_NOTE_GENERATOR "$"1 "$"2 "$"3 
}" > ~/.gitlab_release_note_generator.sh    

Add permission chmod +x ~/.gitlab_release_note_generator.sh

Add created shell command to .bashrc or .zshrc or your preffered shell

echo source ~/.gitlab_release_note_generator.sh  >> ~/.zshrc

Usage

generate_release_notes <Host-Name> <Private-Token> <Project-ID> 

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gitlab_release_note_generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the GitlabReleaseNoteGenerator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.