immoscout 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4cd53b266de26d3e819cdfedba39ced10517813e4aed918c7bb9eb243a1c9e2
-  data.tar.gz: 4e9e75201da0c3a21da12f1c162f078c71fc393e4e350837fd39beca00dc83db
+  metadata.gz: '0963b01092150e79cbf300a7431858238be834bb8c20a433614ed1077079108c'
+  data.tar.gz: d723c91babe0517162622c82a5b9574f29e5bb2cce2ae495684585539c6f6d2c
 SHA512:
-  metadata.gz: 519df9e86e1f3bf3616c24ff3684b5be431a4261e9b2521afa807ae8ae15f23913552bb543b664559242d5f74bb23b4d6aff34bc2cda1fdf2e8d0086c77cd8c9
-  data.tar.gz: 145b56aea60a069fb70b29d7e46774f9f72f05ff50b10df6579d34760939f19c4ff44d7df7ebf089d9c32f2f1d3a3b4beb11b37dc6844d9514b9eb71cfc024ec
+  metadata.gz: c5107284073b8c5ef76026e1fa3da07cb82866925a03e980e91fdeb8df63a252309a787b008fe111c7a07eb84f7fb362150f29638222cf4a9b0f8703c60e87e5
+  data.tar.gz: 14739b826ef34d6f0560dd6cc6fe2b708973af48db972298bb4110902b1831ccff4e0c8bc4af9472113c70f6a0a6588ab027677ecf4e5d315c3a5400953abe99

data/.github/workflows/release.yml

@@ -0,0 +1,47 @@
+name: Release
+run-name: Release ${{ github.event.inputs.VERSION }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      VERSION:
+        description: The new version to release. (eg. `1.0.0`) Check the
+          changelog for the latest version.
+
+concurrency:
+  group: '${{ github.event.inputs.VERSION }}'
+  cancel-in-progress: true
+
+jobs:
+  docs:
+    name: Release the gem
+    runs-on: ubuntu-22.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Ruby 2.5
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+          rubygems: '3.3.26'
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Switch to SSH remotes for the Git repository
+        run: git-ssh-remotes
+
+      - name: Enforce version '${{ github.event.inputs.VERSION }}'
+        run: set-gem-version '${{ github.event.inputs.VERSION }}'
+
+      - name: Prepare the Git release commit
+        run: git-release-commit '${{ github.event.inputs.VERSION }}'
+
+      - name: Push the release Git commit/tag and package to the registry
+        run: make release

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### next
+
+* TODO: Replace this bullet point with an actual description of a change.
+
+### 1.5.0
+
+* Added support for Gem release automation
+
 ### 1.4.0
 
 * Bundler >= 2.3 is from now on required as minimal version (#10)

data/README.md

@@ -28,9 +28,9 @@ the well known _ActiveRecord-like_ model methods.
     - [Attachment (Picture & Document)](#attachment-picture--document)
       - [Overview supported actions](#overview-supported-actions-3)
 - [Development](#development)
-- [Contributing](#contributing)
-- [License](#license)
 - [Code of Conduct](#code-of-conduct)
+- [Contributing](#contributing)
+- [Releasing](#releasing)
 
 ## Installation
 
@@ -217,34 +217,32 @@ picture.destroy # attachment destroy!
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`rake spec` to run the tests. You can also run `bin/console` for an interactive
-prompt that will allow you to experiment.
+After checking out the repo, run `make install` to install dependencies. Then,
+run `make test` to run the tests. You can also run `make shell-irb` for an
+interactive prompt that will allow you to experiment.
 
 To run specs against the immobilienscout24 sandbox api, you need to create some
 keys and tokens. Copy the `spec/test_config.yml.example` to
 `spec/test_config.yml` and fill in your generated values.
 
-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](https://rubygems.org).
+## Code of Conduct
+
+Everyone interacting in the project codebase, issue tracker, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](./CODE_OF_CONDUCT.md).
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/hausgold/immoscout. This project is intended to be a safe,
-welcoming space for collaboration, and contributors are expected to adhere to
-the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## License
-
-The gem is available as open source under the terms of the [MIT
-License](http://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Immoscout project’s codebases, issue trackers, chat
-rooms and mailing lists is expected to follow the [code of
-conduct](https://github.com/hausgold/immoscout/blob/master/CODE_OF_CONDUCT.md).
+https://github.com/hausgold/immoscout. Make sure that every pull request adds
+a bullet point to the [changelog](./CHANGELOG.md) file with a reference to the
+actual pull request.
+
+## Releasing
+
+The release process of this Gem is fully automated. You just need to open the
+Github Actions [Release
+Workflow](https://github.com/hausgold/immoscout/actions/workflows/release.yml)
+and trigger a new run via the **Run workflow** button. Insert the new version
+number (check the [changelog](./CHANGELOG.md) first for the latest release) and
+you're done.

data/lib/immoscout/version.rb

@@ -3,7 +3,7 @@
 # The gem version details.
 module Immoscout
   # The version of the +immoscout+ gem
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 
   class << self
     # Returns the version of gem as a string.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: immoscout
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Marcus Geissler
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -346,7 +346,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.1
-description:
+description: 
 email:
 - marcus3006@gmail.com
 executables: []
@@ -355,6 +355,7 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".github/workflows/documentation.yml"
+- ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".reek"
@@ -420,7 +421,7 @@ files:
 - lib/immoscout/models/picture.rb
 - lib/immoscout/models/publish.rb
 - lib/immoscout/version.rb
-homepage:
+homepage: 
 licenses:
 - MIT
 metadata:
@@ -429,7 +430,7 @@ metadata:
   changelog_uri: https://github.com/hausgold/immoscout/blob/master/CHANGELOG.md
   bug_tracker_uri: https://github.com/hausgold/immoscout/issues
   documentation_uri: https://www.rubydoc.info/gems/immoscout
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -444,8 +445,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
-signing_key:
+rubygems_version: 3.3.26
+signing_key: 
 specification_version: 4
 summary: Ruby client for the Immobilienscout24 REST API
 test_files: []