keyless 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ad87d423bc0cef68c4d459e72f3174952573a16c0a27402523f2d4bd4848f82
-  data.tar.gz: ca15bb771175ffd11bbd5500ef176efd8c21154ebde397a90a06678b1e3ea388
+  metadata.gz: bf3b27e57dd5695ad190bc2940a7cdb7b08ea79b66d35bdf4c2d67acefa6cc42
+  data.tar.gz: aed02f107d55f5a77e50c724fa517a50864ec42f16d4c505ab84ed31d4443cf6
 SHA512:
-  metadata.gz: e23bfd4256a676890fea5fb72b0ee4731ad155e66a56f91dce9bc03a2cd093f4ca3d6b81dcbbf774aebe01da07a44ba26d25f749fb5121e77dbcf4a113698135
-  data.tar.gz: cfb172a94afdb55206a76a8bd77852d58028229f001356c207a77f7edea34e4850e308ffcce9864be75c6b52eaeaf6206778cad88c8ca553027ead068fc90e1e
+  metadata.gz: 2669da4e5baf3e6bf8fc6f3b37e28b9e09278ba245f8057fd80e332b4bee8b4c34195bba07b22b549fca6213722fc1ac9ad1f58186cd30b835524009e79daf42
+  data.tar.gz: 6f5ff05b341d0991786a76aff5d6f3a042800fe6a9f5fdc8a3a92e037c9b76eaa6b7d6f6d690442e4f0d85dc831c40b5ccb4ff736fa5953170d0c21ff2f8604d

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+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 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.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -25,7 +25,9 @@ flexible on the JWT verification level.
     - [Custom JWT verification key](#custom-jwt-verification-key)
   - [Full RSA256 example](#full-rsa256-example)
 - [Development](#development)
+- [Code of Conduct](#code-of-conduct)
 - [Contributing](#contributing)
+- [Releasing](#releasing)
 
 ## Installation
 
@@ -265,17 +267,28 @@ end
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`bundle exec rake spec` to run the tests. You can also run `bin/console` for an
+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 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/keyless.
+https://github.com/hausgold/keyless. 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/keyless/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/keyless/version.rb

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

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: keyless
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Hermann Mayer
 - Christopher Mühl
 - Marcus Geißler
-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
@@ -303,6 +303,7 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".github/workflows/documentation.yml"
+- ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
@@ -311,6 +312,7 @@ files:
 - ".yardopts"
 - Appraisals
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Dockerfile
 - Envfile
 - Gemfile
@@ -333,7 +335,7 @@ files:
 - lib/keyless/jwt.rb
 - lib/keyless/rsa_public_key.rb
 - lib/keyless/version.rb
-homepage:
+homepage: 
 licenses:
 - MIT
 metadata:
@@ -342,7 +344,7 @@ metadata:
   changelog_uri: https://github.com/hausgold/keyless/blob/master/CHANGELOG.md
   bug_tracker_uri: https://github.com/hausgold/keyless/issues
   documentation_uri: https://www.rubydoc.info/gems/keyless
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -357,8 +359,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 JWT authentication helper
 test_files: []