Kleister: SDK for Ruby

General Workflow Join the Matrix chat at https://matrix.to/#/#kleister:matrix.org Codacy Badge Gem Version

This repository provides a client SDK for Ruby. This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0-alpha1
  • Package version: 3.1.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

For more information, please visit https://kleister.eu

Installation

Build a gem

If you want to build an unreleased version of this library you are able to build it locally with the following command, afterwards you should be able to install the built gem:

gem build kleister.gemspec
gem install ./kleister-3.1.0.gem

Install from Rubygems

If you want to use a a properly released version hosted Rubygems you just need to add the following line to your Gemfile:

gem 'kleister', '~> 3.1.0'

Install from Git

If the gem is hosted at a git repository, then add the following in the Gemfile:

gem 'kleister', :git => 'https://github.com/kleister/kleister-ruby.git'

Security

If you find a security issue please contact kleister@webhippie.de first.

Generating

We use mise to manage all required tools and their versions. Install it by following the official installation instructions, then run the following commands inside the repository to activate mise and install all tools defined in mise.toml:

mise trust
mise install

Contributing

Generally we are following conventional commits when we apply changes. That way we are able to generate proper changelogs for every release. Please use always pull requests to integrate new functionalities or to fix issues.

For the release process we are following semantic versioning which clearly indicates if a new version just resolves bugs, includes new features or even includes breaking changes.

After installing the tools via mise install as described above set up the pre-commit hooks so they run automatically on every commit:

pre-commit install --hook-type pre-commit --hook-type commit-msg

pre-commit is managed by mise and will be available after mise install.

If you have changed something on the source you should simply commit following the mentioned conventions:

git checkout -b feat/new-feature
git add --all
git commit -m 'feat: added awesome new feature'
git push --set-upstream origin feat/new-feature

After pushing your changes into the Git repository you should create a pull request on GitHub. If the pull request have been merged and everything built fine it will also create automatically a new release at least once a week.

Authors

License

Apache-2.0

Copyright (c) 2018 Thomas Boerger <thomas@webhippie.de>