To get started with Haystack, you simple need to Install our Github Application.
Before getting into how to install, I'm sure you have some questions. We've taken the liberty of writing up the most common questions we get:
Frequently Asked Questions
What permissions do you need?
For Haystack to provide meaningful insights, it needs read-access to the github repositories you would like to include. See the full list of permissions here.
What data do you pull?
Haystack uses only uses metadata (messages, timestamps, status, tags) on pull requests and commits.
Do you store or read source code?
Haystack does NOT read, store, or persist source code.
Can I see your security and privacy policies?
Installing our Github App
Step 1: Navigate to our Github App Page
You should see a simple page with our Haystack Application. It should look like this:
Step 2: Click "Configure"
In the top-right of the page, you should see an option to "Configure"
Step 3: Select A Github Account
Select which Github account to install Haystack. Select the organization that your team actively works on.
Note: We require active Github organizations and do not accept inactive or personal Github accounts.
Step 4: Select Repositories
Select which repositories to use. These repositories will be granted read-only access to Haystack. You can select either "All Repositories" or select which specific repositories to include.
Note: If you select specific repositories, you will have to repeat this step for newly created repositories.
Step 5: You're Done!
Now that you've installed our Github Application, your account will begin processing. Due to Github API limitations, this process may take up to 24 hours.
You'll receive an email once your account has completed processing.