| description |
|---|
You are just a click away from installing Catana. |
{% hint style="info" %} Catana can only be installed on GitHub repositories at the moment. {% endhint %}
The first time you sign in to Catana, you will be prompted to install the application and will be redirected to GitHub.
Install the GitHub application.
Choose the account on which you would like to proceed with the installation, and click "Install". Congratulations, you have successfully installed Catana! 🥳
Choose the organization where you would like to install Catana.
Once Catana is installed, other members of your organization will not be prompted to follow this step.
{% hint style="info" %} Manually enrolling a repository allows each team and project to decide whether they'd like to opt-in. {% endhint %}
After installing the GitHub application, you'll be redirected back to Catana where you'll choose
which repositories you'd like to enrol. You can choose as many repositories as you want!
Enrolling a repository enables the following functionalities:
- 🔍 Let Catana search and process existing TODOs.
- 💾 Record upcoming TODOs whenever a git push occurs on the release branch (usually
mainormaster). - ✅ Add a failing or successful CI check status on Pull Requests introducing a TODO.
Enrol your repository and discover Catana!
This operation can take a few minutes based on how large the repository is and the number of TODOs found.