GitHub Actions Templates

Automate community integrations for your Orbit workspace with these GitHub Actions template starter files

Overview

This repository helps you get up and running with third party integrations to Orbit in a matter of minutes.

Inside this repository are template YAML workflow files you can use to automate third party integrations with your Orbit workspace.

What are 3rd party integrations?

All Orbit users have access to built-in integrations, such as GitHub, Twitter, Slack, and Discord. These built-in integrations can be added and set up from within the Orbit app.

Community-built, or 3rd party integrations, are additional integrations offered by the larger Orbit community. While not officially supported, they offer many opportunities to further extend the utility of the platform.

What is this repository for?

Within each subfolder of this repository is a GitHub Actions workflow template file, along with instructions on how to use it. GitHub Actions is a runtime environment provided by GitHub to any GitHub user. You can run applications on GitHub Actions for free on any publicly available (not private) repository.

First Time Setup

Before setting up an integration using GitHub Actions, you will need to follow the First Time Setup Guide

Available Integrations

The following integration workflows are available to use, and more will be added:

To use a workflow, please follow the integration-specific instructions.

Frequently Asked Questions

• Does this have anything to do with Orbit's GitHub Integration? No - setting up community integrations using GitHub Actions is independent of the integration. We are essentially using GitHub Actions as a free host and scheduler of our code.
• Are there any requirements of the repository I put my .yml files in? No - it can be called anything, and contain any other files. As long as your workflows are inside of the .github/workflows directory it can go in any repository.
• How much does it cost? GitHub provides a generous but limited allowance for using GitHub Actions in private repositories which should be plenty for most communities. If you are using a lot of GitHub Actions either from Orbit or elsewhere, consider making your repository public for unlimited free runs. More info.
• Do I need to do any maintainence? Once you set up a GitHub Actions workflow you shouldn't need to do much to it to keep it running. If you are ingesting very large amounts of data you may hit rate limits - check the logs of any failed executions if this happens for more information. GitHub also require some repository activity on the main branch every 60 days to keep actions running. You should receive an email 7 days before this with notice. More info.

Contributing

We ❤️ contributions! Please read the Contribution Guidelines on how to get involved and submit your own 3rd party integration template.

Code of Conduct

This project has a Contributor Code of Conduct. We ask everyone to please adhere by its guidelines.

License

This project is under the MIT License.