This is a GitHub template for creating tomo plugins, which are packaged as Ruby gems.
Read the tomo tutorial Publishing a Plugin to get started. Then press Use this template to generate a project from this template. In the generated project, run this script to rename the gem to meet your needs:
ruby rename_template.rb
Note that to get the full benefits of the script, you will need the gh command installed.
This template is based on bundle gem
with some notable improvements:
- GitHub Actions configuration
- Minitest, with minitest-rg for nicely formatted test output
- Rubocop with a good set of configuration
- release-drafter GitHub Action for automating release notes
- A
rake bump
task to keep your Ruby and Bundler dependencies up to date - A nice README with badges ready to go (see below)
This is a tomo plugin that ... TODO: Description of this plugin goes here.
Run:
gem install tomo-plugin-example
Or add it to your Gemfile:
gem "tomo-plugin-example"
Then add the following to .tomo/config.rb
:
plugin "example"
TODO: document plugin settings
Name | Purpose | Default |
---|---|---|
plugin_name_setting |
TODO | nil |
TODO: document plugin tasks
TODO
If you want to report a bug, or have ideas, feedback or questions about the gem, let me know via GitHub issues and I will do my best to provide a helpful answer. Happy hacking!
The gem is available as open source under the terms of the MIT License.
Everyone interacting in this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
Pull requests are welcome!