alarmable 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '079b8b2c656b50417dde03ebcccbb4d7b55dc249d90cee9974b1eed7f5089415'
-  data.tar.gz: 476c6acbe31bda140cf04b3840e7db36328ad57f05734a95f43a9683986ee180
+  metadata.gz: a92750970481aece8a70aa0d7aed9ffb2f14745d524b330559629563739401ef
+  data.tar.gz: 6bf3588f912875f7ce1708d3d0ade33c9364e0e65292c60140880482e9b3ba64
 SHA512:
-  metadata.gz: 540427e743f6a1fff246966b2ddb29c12a86de7f0e537d62bc8be3d0b6d8ac1c21830949577b238a3b509acaa2b26f886bc931fe41f550757381752840351e16
-  data.tar.gz: 1fd04a3f3effb30f4db9fd2d2b47d0bd00fcd0bbbfcf82cc6da0466c9b90b4d6853807f8b8fcd10e360b7ebbfe0e3551c9152db0dbaa488b1cae52b5e93c414f
+  metadata.gz: 1fdb5e174b57b08d20ad0ed51a89d1f269dd400843186b0f6a8c3acffeeb5deaa683c41cce0cc6ab61048cd3a6cc5171190bcbcb38b2b06571230afecec35914
+  data.tar.gz: 2481ff443192e908b1e4dbd54b1866bcf83366526fab873ccf42a7d0e67795c8b2fc47bd3cc01dc760c565c219a20fe79b5fcc338eb4ae740a8d863e44f57e77

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.1.0
+
+* Added support for Gem release automation
+
 ### 1.0.0
 
 * Bundler >= 2.3 is from now on required as minimal version (#4)

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at hermann.mayer92@gmail.com. All
+reported by contacting the project team at development@hausgold.de. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/LICENSE

@@ -1,4 +1,4 @@
-The MIT License (MIT)
+MIT License
 
 Copyright (c) 2023 HAUSGOLD | talocasa GmbH
 
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -19,7 +19,9 @@ list of supported adapters)
   - [Active Record Model](#active-record-model)
   - [Active Job](#active-job)
 - [Development](#development)
+- [Code of Conduct](#code-of-conduct)
 - [Contributing](#contributing)
+- [Releasing](#releasing)
 
 ## Installation
 
@@ -114,12 +116,24 @@ 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 release a new version, update the version number in `version.rb`, and then
-run `make 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/alarmable.
+https://github.com/hausgold/alarmable. 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/alarmable/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/alarmable/version.rb

@@ -3,7 +3,7 @@
 # The gem version details.
 module Alarmable
   # The version of the +alarmable+ gem
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 
   class << self
     # Returns the version of gem as a string.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alarmable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Hermann Mayer
-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: activejob
@@ -286,6 +286,7 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".github/workflows/documentation.yml"
+- ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
@@ -315,7 +316,7 @@ files:
 - lib/alarmable.rb
 - lib/alarmable/concern.rb
 - lib/alarmable/version.rb
-homepage:
+homepage: 
 licenses:
 - MIT
 metadata:
@@ -324,7 +325,7 @@ metadata:
   changelog_uri: https://github.com/hausgold/alarmable/blob/master/CHANGELOG.md
   bug_tracker_uri: https://github.com/hausgold/alarmable/issues
   documentation_uri: https://www.rubydoc.info/gems/alarmable
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -339,8 +340,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: A reusable alarm extension to Active Record models
 test_files: []