Skip to content

Commit

Permalink
Prepare release v0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
andreslucena committed Mar 15, 2024
1 parent 7695b05 commit ae811e1
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 10 deletions.
18 changes: 18 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.0] - 2024-03-15

### Added

- Initial release with the scripts:
- `decidim-backporter`: to do the backports itself.
- `decidim-backports-checker`: to see the status of the pending backports.
- `decidim-changelog-generator`: to generate the changelog for a release.
- `decidim-releaser`: to do the release itself.

[0.0.1]: https://github.com/decidim/decidim-maintainers_toolbox/releases/tag/v0.1.0
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,10 @@ Tools for releasing, backporting, changelog generating, and working with GitHub

## Installation

TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you do not plan to release to RubyGems.org.

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.

```console
gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
gem install decidim-maintainers_toolbox
```

## Usage
Expand Down Expand Up @@ -55,13 +53,13 @@ As this gem is meant to be used outside of the main decidim gems, we will not fo

To release this gem, follow these steps:

. Bump the version number in `lib/decidim/maintainers_toolbox/version.rb` following [Semantic Versioning](https://semver.org/).
. Update the `CHANGELOG.md` with the new version and the changes.
. Commit the changes.
. Create a new tag with the version number.
. Push the changes and the tag to the repository.
. Run `rake build` to build the gem.
. Run `rake release` to publish the gem to [rubygems.org](https://rubygems.org).
1. Bump the version number in `lib/decidim/maintainers_toolbox/version.rb` following [Semantic Versioning](https://semver.org/).
1. Update the `CHANGELOG.md` with the new version and the changes.
1. Commit the changes.
1. Create a new tag with the version number.
1. Push the changes and the tag to the repository.
1. Run `rake build` to build the gem.
1. Run `rake release` to publish the gem to [rubygems.org](https://rubygems.org).

## Contributing

Expand Down

0 comments on commit ae811e1

Please sign in to comment.