Redocly connects to your source control to offer continuous validation and delivery of your:
- API definitions
- API reference docs
- API developer portal
- More (contact us firstname.lastname@example.org to learn about what else we can automate)
Redocly has integrated with popular version control software tools such as GitHub, GitHub Enterprise, and Azure Repos. When a pull request is opened, or a commit made and pushed to those services, Redocly can be notified automatically and, for example, validate your API definition and build a preview of your API reference docs.
We recommend following a git-ops docs-like-code workflow. However, we also support other non-git-based sources such as file uploads, URLs, and CI/CD (coming soon for enterprises).
Redocly can trigger workflows based commits pushed and on Pull Requests opened or changed.
You can connect to:
- GitHub Enterprise
- Azure Repos
- GitLab self-managed
- Bitbucket Cloud (comming soon)
- Bitbucket self-managed (Server or Data Center)
Redocly will run the workflows on demand, when you upload the file(s).
Redocly can poll a URL at regular intervals and if there is a change we will validate, bundle, add it to the registry, and trigger the workflow.