foobara-typescript-remote-command-generator

Typescript::Remote::Command::Generator

TODO: Delete this and the text below, and describe your gem

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/typescript/remote/command/generator. To experiment with that code, run bin/console for an interactive prompt.

Installation

From this directory, run the following:

bundle config set local.foobara ../foobara
bundle config set disable_local_branch_check true

NOTE: you don´t need to do this because it is already done, but when setting up a new project, you need to put a valid private key in TYPESCRIPT_REMOTE_COMMAND_GENERATOR_KEY_FOR_FOOBARA in gitub actions secrets for this repository.

TODO: Replace UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.

Install the gem and add to the application's Gemfile by executing:

$ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG

Usage

TODO: Write usage instructions here

Development

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.

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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/typescript-remote-command-generator.

License

This project is licensed under your choice of the Apache-2.0 license or the MIT license. See LICENSE.txt for more info about licensing.