Skip to content

Commit

Permalink
Add releases instructions and CI workflow (#1)
Browse files Browse the repository at this point in the history
* Add releases instructions in README

* Add github actions workflow
  • Loading branch information
andreslucena committed Mar 15, 2024
1 parent 7f20f10 commit 7695b05
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/ci_maintainers_toolbox.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: "[CI] Maintainers' toolbox"
on:
push:
branches:
- develop
- release/*
- "*-stable"
pull_request:
branches-ignore:
- "chore/l10n*"

env:
CI: "true"
SIMPLECOV: "true"
RUBY_VERSION: 2.7.5

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true

jobs:
lint:
strategy:
fail-fast: false
matrix:
command:
- bundle exec rspec
name: Lint code
runs-on: ubuntu-latest
if: "!startsWith(github.head_ref, 'chore/l10n')"
timeout-minutes: 60
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 1
- uses: ruby/setup-ruby@v1
with:
ruby-version: ${{ env.RUBY_VERSION }}
bundler-cache: true
- run: ${{ matrix.command }}
name: ${{ matrix.command }}
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ 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
Expand All @@ -47,6 +49,20 @@ After checking out the repo, run `bin/setup` to install dependencies. You can al

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](https://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:

. 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).

## Contributing

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

0 comments on commit 7695b05

Please sign in to comment.