This library is a ruby implementation necessary for beginning your GitHub bot development for Ruby-based projects. The key items this project provides to consumers are the following:
- Generic or application specific webhook mounted routes
- Octokit API configuration via Railtie
- Base classes for both your tasks and validators
See wiki for more details.
This project is built using Ruby 2.6+, Rake and Bundler. RSpec is used for unit tests and SimpleCov is utilized for test coverage. RuboCop is used to monitor the lint and style.
To setup the development workspace, run the following after checkout:
gem install bundler
bundle install
To run the RSpec tests, run the following:
bin/rspec
To analyze the project's style and lint, run the following:
bin/rubocop
To analyze the project's dependency vulnerabilities, run the following:
bin/bundle audit
This RubyGem will be available on https://rubygems.org/.
All questions, bugs, enhancements and pull requests can be submitted here, on GitHub via Issues.
See CONTRIBUTING.md
Copyright 2021 Cerner Innovation, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Everyone interacting in the GithubBot project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.