Automate integrating Circle interactions into your Orbit workspace with this GitHub Actions template
There are two checks included in the Circle automation template, they occur once a day:
- Check for new posts in your Circle Spaces
- Check for new comments on posts in your Circle Spaces
If there are new posts or comments they will be added to your Orbit workspace.
To use this workflow:
-
Copy the circle.yml file into your own GitHub repository inside your
.github/workflowsdirectory -
The automation requires your Circle API key and your Circle community URL be added to your GitHub repository secrets.
- Follow the steps in the GitHub Actions Templates First Time Setup Guide and add the following additional secret:
CIRCLE_API_KEY: Create a new API key in the API section in your User SettingsCIRCLE_URL: This is your Circle custom URL, for example:https://orbit.circle.so
- Follow the steps in the GitHub Actions Templates First Time Setup Guide and add the following additional secret:
-
This workflow will automatically filter out any Circle posts or comments that are older than the most recent Circle posts and comments in your Orbit workspace currently.
- To perform a historical import, that will send to Orbit all of your Circle posts and comments add the
--historical-importflag to the workflow file on both line 24 and line 32:circle_orbit --check-comments --historical-importcircle_orbit --check-posts --historical-import
- You should only need to run a historical import once, and it is recommended to remove the
--historical-importflag after.
- To perform a historical import, that will send to Orbit all of your Circle posts and comments add the
Once the workflow and credentials have been added to your GitHub repository, the workflow will be activated. You do not need to do anything else to activate it.