Merge pull request #222 from bastelfreak/changelog

prepare 1.0.0 release

.github/workflows/test-build-release.yml

@@ -10,13 +10,15 @@ name: test-build-release
 on:
   push:
     branches: master
+    tags:
+      - '*'
 
 jobs:
   test:
 
     runs-on: ubuntu-latest
     env:
-      BUNDLE_WITHOUT: development
+      BUNDLE_WITHOUT: development:release
 
     steps:
     - uses: actions/checkout@v2

.github/workflows/test-build.yml

@@ -16,7 +16,7 @@ jobs:
 
     runs-on: ubuntu-latest
     env:
-      BUNDLE_WITHOUT: development
+      BUNDLE_WITHOUT: development:release
 
     steps:
     - uses: actions/checkout@v2

Gemfile

@@ -82,3 +82,7 @@ group :test do
   gem 'rubocop-rails'
   gem 'selenium-webdriver'
 end
+
+group :release do
+  gem 'github_changelog_generator', require: false
+end

Gemfile.lock

@@ -65,6 +65,24 @@ GEM
     archive-zip (0.12.0)
       io-like (~> 0.3.0)
     ast (2.4.2)
+    async (1.30.1)
+      console (~> 1.10)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    async-http (0.56.5)
+      async (>= 1.25)
+      async-io (>= 1.28)
+      async-pool (>= 0.2)
+      protocol-http (~> 0.22.0)
+      protocol-http1 (~> 0.14.0)
+      protocol-http2 (~> 0.14.0)
+    async-http-faraday (0.11.0)
+      async-http (~> 0.42)
+      faraday
+    async-io (1.32.2)
+      async
+    async-pool (0.3.8)
+      async (>= 1.25)
     autoprefixer-rails (10.2.5.1)
       execjs (> 0)
     awesome_print (1.9.2)
@@ -99,6 +117,8 @@ GEM
     coffee-script-source (1.12.2)
     concurrent-ruby (1.1.9)
     connection_pool (2.2.5)
+    console (1.13.1)
+      fiber-local
     crass (1.0.6)
     e2mmap (0.1.0)
     erubi (1.10.0)
@@ -120,6 +140,8 @@ GEM
     faraday-em_http (1.0.0)
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
     faraday-httpclient (1.0.1)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
@@ -129,6 +151,7 @@ GEM
       faraday (~> 1.0)
     fast_gettext (1.1.2)
     ffi (1.15.3)
+    fiber-local (1.0.0)
     fomantic-ui-sass (2.8.7.1)
       autoprefixer-rails
       rails (>= 3.2.0)
@@ -146,6 +169,15 @@ GEM
       fast_gettext (~> 1.1.0)
       gettext (>= 3.0.2, < 3.3.0)
       locale
+    github_changelog_generator (1.16.4)
+      activesupport
+      async (>= 1.25.0)
+      async-http-faraday
+      faraday-http-cache
+      multi_json
+      octokit (~> 4.6)
+      rainbow (>= 2.2.1)
+      rake (>= 10.0)
     globalid (0.5.2)
       activesupport (>= 5.0)
     groupdate (5.2.2)
@@ -282,6 +314,13 @@ GEM
     parser (3.0.2.0)
       ast (~> 2.4.1)
     pg (1.2.3)
+    protocol-hpack (1.4.2)
+    protocol-http (0.22.5)
+    protocol-http1 (0.14.2)
+      protocol-http (~> 0.22)
+    protocol-http2 (0.14.2)
+      protocol-hpack (~> 1.4)
+      protocol-http (~> 0.18)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -424,6 +463,7 @@ GEM
     thwait (0.2.0)
       e2mmap
     tilt (2.0.10)
+    timers (4.3.3)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     uglifier (4.2.0)
@@ -450,6 +490,7 @@ DEPENDENCIES
   execjs
   fomantic-ui-sass (= 2.8.7.1)
   foreman
+  github_changelog_generator
   groupdate
   haml-lint
   haml-rails
@@ -493,4 +534,4 @@ DEPENDENCIES
   uglifier (>= 1.3.0)
 
 BUNDLED WITH
-   2.2.24
+   2.2.26

README.md

@@ -36,6 +36,7 @@
   - [License](#license)
   - [Docker tricks](#docker-tricks)
   - [Sponsor](#sponsor)
+  - [Prepare a release](#prepare-a-release)
 
 ## Purpose
 
@@ -475,3 +476,14 @@ provide us with free cloud instances to host the application.
 
 Are you interested as well in sponsoring parts of the Vox Pupuli organisation?
 Get in touch with the [Project Management Committee](mailto:[email protected]).
+
+## Prepare a release
+
+We use the [GitHub changelog generator](https://github.com/github-changelog-generator/github-changelog-generator#github-changelog-generator-)
+to generate our `CHANGELOG.md`. To prepare a new release, write the desired
+version into our `Rakefile`. Afterwards export a GitHub API token as
+`CHANGELOG_GITHUB_TOKEN` environment variable. Now you can generate the
+changelog with `bundle exec rake changelog`. Propose that as a pull request.
+
+If it gets approved and merged, you can create a git tag and push it. Our CI
+platform will take care of pushing a matching docker image.

Rakefile

@@ -24,3 +24,16 @@ desc 'Display the list of available rake tasks'
 task help: :environment do
   system('rake -T')
 end
+
+begin
+  require 'github_changelog_generator/task'
+
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.header = "# Changelog\n\nAll notable changes to this project will be documented in this file."
+    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog dependencies]
+    config.user = 'voxpupuli'
+    config.project = 'vox-pupuli-tasks'
+    config.future_release = 'v1.0.0'
+  end
+rescue LoadError # rubocop:disable Lint/SuppressedException
+end