Contributing an integration
You can build an integration that connects Tangled to a different service using the public API or by simply listening for events on a firehose. If you write an integration, get in touch, and we could get it documented here!
Listening for events
Section titled “Listening for events”Each repository has its own DID. The records of a repository, for example issues, pull requests and artifacts, can be filtered and streamed using Jetstream.
Some records are owned by users, and not repositories. For example, a star is in the repository of the user that gives the star.
Refer to Records for the record types.
Get more data
Section titled “Get more data”Use the Bobbin API at https://api.tangled.org
to get data that is not in the records. For example:
org.tangled.repo.getRepoByNamegives the DID of a repository.org.tangled.temp.git.listTagsgives the tags and their messages.org.tangled.feed.countStarsgives the star count.
Add documentation
Section titled “Add documentation”When your integration is ready, add a page for it here:
- Add a Markdown file in
docs/src/content/docs/integrations/. - Add the page to the Integrations section of the sidebar in
docs/astro.config.mjs. - Tell users how to install the integration and how to use it. Keep the page short.
- Send a pull request. Refer to the Contribution guide.