K Ext Github

KExt/Github provides useful github extensions specifically for the klueless code generator

Installation

Add this line to your application's Gemfile:

gem 'k_ext-github'

And then execute:

bundle install

Or install it yourself as:

gem install k_ext-github

Stories

Main Story

As a Developer, I need manage github repositories, so that my code is version controlled

See all stories

Usage

See all usage examples

Basic Example

List all repositories

Get a list of all repositories linked to this personal access token

pat = KExt::Github.configuration.personal_access_token
api = KExt::Github::Api.new(token: pat)

repos = api.repositories

KExt::Github::Printer.repositories_as_table(repos)

List all

List Repos

List repositories for specific organization

Get a list of repositories for the organization klueless-csharp-samples linked to this personal access token

pat = KExt::Github.configuration.personal_access_token
api = KExt::Github::Api.new(token: pat)

repos = api.organization_repositories('klueless-csharp-samples')

KExt::Github::Printer.repositories_as_table(repos)

List repos by organization

List Repos

Development

Checkout the repo

git clone klueless-io/k_ext-github

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.

bin/console

Aaa::Bbb::Program.execute()
# => ""

k_ext-github is setup with Guard, run guard, this will watch development file changes and run tests automatically, if successful, it will then run rubocop for style quality.

To release a new version, update the version number in version.rb, build the gem and push the .gem file to rubygems.org.

rake publish
rake clean

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/klueless-io/k_ext-github. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the K Ext Github project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Copyright (c) David Cruwys. See MIT License for further details.