Hephaestus

A plug template for Yetto. It serves two purposes:

  1. Use this to quickly spin up new plugs with a set of defaults.
  2. Hephaestus also exists as an engine, and is responsible for the majority of a plug's Yetto communication logic.

Usage

First, install Hephaestus globally, on your system:

gem install hephaestus

Then, in the parent directory where you want your plug to be created, run:

hephaestus plug-app

Where app represents the name of the platform you'd like to interact with, like jira, notion, slack, etc.

Testing locally

If you're working on updating/testing this gem locally, you may also try:

rm -rf plug-app && DEBUG=1 bundle exec hephaestus/bin/hephaestus plug-app

This way you can wipe the dir and quickly iterate on new changes.

If you're having trouble connecting to the Internet, you can set HEPHAESTUS_NO_EXTERNAL=1.

Acknowledgements

The template generation for this project was heavily based on thoughtbot/suspenders.