decidim-maintainers_toolbox

Decidim::MaintainersToolbox

Release related tools for the Decidim project.

Tools for releasing, backporting, changelog generating, and working with GitHub

Installation

This gem is meant to be used outside of bundler/Gemfile so we do not need to bump the version every time we release a new one to each of the releases branch.

gem install decidim-maintainers_toolbox

Usage

This gem allows preparing and working with Decidim releases. Is it meant to be used by maintainers of the project. In the near future most of these tools will be used by decidim-bot.

There are a couple differences with the rest of the gems of this repository:

• About the versioning: as it has not decidim nor decidim-core as dependencies, and to keep it easy to work with, we will not have the same versioning as the others gems.
• About the ruby version: to make it possible to work with older decidim versions, we will support the lowest supported ruby version.

This is the reason why its in a different repository and not in the decidim repository.

The main scripts are decidim-backporter, decidim-backports-checker, decidim-changelog-generator and decidim-releaser.

decidim-backporter

See Backports documentation

decidim-backports-checker

See Backports documentation

decidim-changelog-generator

Used for generating the changelog with all the Pull Requests that goes to the current release. To be used automatically by the releaser script.

decidim-releaser

See Releasing new versions documentation

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 the created tag, and push the .gem file to rubygems.org.

Releases

As this gem is meant to be used outside of the main decidim gems, we will not follow the same versioning. We will release a new version of this gem every time we have a new feature or bugfix that we need to use. This also means that we will not follow the same release process.

To release this gem, follow these steps:

1. Bump the version number in lib/decidim/maintainers_toolbox/version.rb following Semantic Versioning.
2. Update the CHANGELOG.md with the new version and the changes.
3. Commit the changes: git commit -m "Prepare release v0.1.0"
4. Create the new tag, push the changs, build and publish with bundle exec rake release[origin]

Mind that you will need to have the right permissions to push to the repository and publish the gem.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/decidim/decidim.