Integrations
GitHub
Connect GitHub so Teaflask can use your repositories to help draft and verify documentation, discover API actions, and discover product pages. The integration uses a GitHub App with read-only repository access.
Connect GitHub
- Open Settings > Integrations > GitHub and start the connection.
- On GitHub, choose the account or organization and the repositories the app may access.
- Complete the installation and any authorization prompts, then return to Teaflask.
The GitHub settings page shows the connected account and repository list.
Set the production branch
The production branch tells Teaflask which version of each repository to use when checking released documentation. Verification reads that branch's current commit, and pushes to it can trigger automatic re-checks. Choose the branch that represents your deployed product, which may differ from the repository's default branch.
Select Configure beside a repository. Choose its default branch, a detected candidate, or Custom branch… to enter a branch name without the refs/heads/ prefix.
Teaflask can flag a production branch that has stopped moving while the default branch continues receiving commits. Check whether the selected branch still represents your release process; a warning does not by itself mean the branch is wrong.
See Verification for how released documentation is checked.
Security
Teaflask clones your repositories into isolated, temporary sandboxes for analysis.
- Read-only access. Teaflask can read your selected repositories but cannot push commits or modify your code on GitHub.
- Short-lived credentials. Access tokens are restricted to the repositories being cloned. Teaflask revokes them after cloning, with automatic expiry as a fallback.
- Network restrictions. Sandboxes do not have unrestricted internet access. Public-internet connections are limited to GitHub and its content hosts.
- Automatic cleanup. Cloned repositories are deleted when their sandboxes are torn down. Automatic inactivity and lifetime limits keep sandboxes temporary.
- You control access. Change the selected repositories or uninstall the app on GitHub, or disconnect it from Teaflask.