To begin importing your data, use the onboarding setup guide on Settings home. Follow our integration guides and video series to guide you through the process. Return to these guides at any time. If you need help connecting to your repositories for the first time, email email@example.com.
Import your data
Once you've completed the first three configuration steps on Settings home, you are ready to import your data. Follow steps 4 through 7 on Settings home to add your integrations and prioritize your repositories.
In step 4, add your integrations.
Before adding integrations:
- Review the git and ticket host permissions required to connect to Flow.
- Create a service account within your git and ticket host to reduce potential errors. Learn more about creating service accounts.
Click Add integration. As you add integrations, enable the services needed from an integration, such as repos, tickets, and pull requests. For a guide on specific integrations, see our integration guides.
Watch the video guide to view the complete process on creating an integration.
Add repo exclusion rules
In step 5, add repo exclusion rules for one or more integrations. Exclusion rules exclude select integrations from auto-importing when auto-import is enabled.
By adding repo exclusion rules, you will:
- see more of the data you want in Flow.
- spend less time manually managing repos.
Adding exclusion rules is optional and can be edited later. If you do not have any repos to exclude, proceed to the next step.
To add an exclusion rule to an integration, click Add exclusion rule next to the integration you want to exclude from auto-import.
You can create rules to exclude:
- repos by name
- repos by regular expression
- repos by date
- archived repos
- open-source repos
For further instruction on how to create each type of repo exclusion rule, learn more about repository auto-import and repo exclusion rules.
Note: Toggling on Exclude archived repos is only available for Git Hub and Git Lab integrations.
Creating a repo exclusion rule for an integration does not apply to that integration’s previously imported repos. For example, if you toggle on Exclude open-source repos, Flow will exclude all future open-source repos, but repos imported prior to creating this rule will still be included. To exclude a previously imported repo, you must manually remove the repo from the repos list.
When you’ve finished creating repo exclusion rules for an integration, click Return to settings home to add repos exclusion rules for another integration or to continue the onboarding process.
Tip: To edit your repo exclusion rules after onboarding, learn more about repository auto-import and repo exclusion rules.
In step 6, the repos your organization wants ingested first. Your organization may want to prioritize repos with recent activity before importing older repos. By prioritizing a smaller set of repos, more relevant data will be available faster. Adding too many repos at once delays processing immensely.
Click Select repos to import to go to the Repos page to import prioritized repos. Use the quick filters to view repos modified within the last month or six months.
Once you've imported your priority repos, they will begin processing. After the repo is ingested, Flow imports associated PR projects.
As you finish the remaining onboarding steps, Flow continues to process your imported repos. Repo processing may take longer than the onboarding process.
Flow will send an email to your inbox when the prioritized repos are ready to view in your reports.
Note: You can add more repos at any time after the onboarding process.
Watch the video series to view the complete repo import process.
For more step-by-step videos about Flow, check out our Flow Getting Started video series.
In step 7, enable auto-import for your integrations. Auto-import pulls in all repo and project data for an integration. The auto-import queue begins after the prioritized repos and tickets are finished processing. By turning auto-import on for an integration, Flow will continue to import any new repos for that integration.
To enable auto-import for an integration, toggle on the Enable auto-import toggle next to the integration. Click Complete.
Any repos excluded through repo exclusion rules will not be imported, even if auto import is on.
You can toggle auto-import on for integrations after the onboarding process. Learn more about auto-import.
Managing your data
Once you've created your integrations and imported your repositories, you should see data in your reports. You are now ready to manage your report data.
Check out how to:
- Manage your integrations
- Manage your repositories
- Manage your pull request projects
- Manage your ticket projects
The initial setup is now complete. Flow will continue processing your repos and ticket data. Processing time may vary depending on the size and number of imported repos. Flow sends you an email when your prioritized repos are processed and ready to be viewed in your reports.
To review your initial configurations, visit the Settings home page.
To use your reports more efficiently, organize your users and teams.
If you need help, please email Support (opens email form) for 24/7 assistance.