Connect and set up
Connecting trackers and repositories
Which work trackers and repository hosts you can connect, and what each needs.
A connection tells Yavaren where your work items live and where the code is. Each connection names its tokens; you paste each token once and it is never shown again (see Tokens: set once, never shown again). Only the runner that does your work reads it, when a job runs.
Work trackers
| Service | What you enter | Secret names in your secret store |
|---|---|---|
| Azure DevOps Boards | org_url, project (optional: api_version, state_on_completed, state_on_needs_review, state_on_skipped, link_pull_requests) |
AZDO_PAT |
| GitHub Issues | owner, name (optional: api_url, state_on_completed, state_on_needs_review, state_on_skipped, link_pull_requests) |
GITHUB_REPO_TOKEN |
| GitLab Issues | project_path (optional: base_url, state_on_completed, state_on_needs_review, state_on_skipped, link_pull_requests) |
GITLAB_TOKEN |
| Jira | base_url, project (optional: acceptance_field, auth_mode, state_on_completed, state_on_needs_review, state_on_skipped, link_pull_requests) |
JIRA_API_TOKEN (optional: JIRA_EMAIL) |
| Yavaren Boards (built in) | (optional: space, state_on_completed, state_on_needs_review, state_on_skipped, link_pull_requests) |
none |
Repository hosts
| Service | What you enter | Secret names in your secret store |
|---|---|---|
| Azure Repos | org_url, project, name (optional: api_version) |
AZDO_PAT |
| Bitbucket Cloud | workspace, name |
BITBUCKET_TOKEN (optional: BITBUCKET_EMAIL) |
| Bitbucket Server / Data Center | base_url, project_key, name |
BITBUCKET_TOKEN |
| GitHub | owner, name (optional: api_url, host) |
GITHUB_REPO_TOKEN |
| GitLab | project_path (optional: base_url) |
GITLAB_TOKEN |
Changing a connection
Choose Edit on a connection to correct a setting or a secret name, or to rename it. When a connection lacks something it needs, it says Needs: … and its button reads Fix. The Getting started page sends you there too. The same checks as adding it apply, and its kind stays. To connect something of another kind, add a new connection. Stories already started keep what they were given; the next ones use the change.
Good practice
- Give each token the smallest permissions it needs: read work items and write comments for a tracker; push to new branches and open pull requests for a repository host.
- A new connection of the same account starts with the same token name as the one you already have. One token that
covers both is fine; it is reused, not asked again. To keep them apart, give the new one its own name, for example
…-2. Pasting a token under a name another connection uses is refused, so a token is never replaced by accident. - Rotate a shared token once: every connection that uses its name gets the new value.
- Choose from a list. Adding a second repository or project of an account you already connected? Next to its repository, project path or project key, choose Choose from …: your runner lists what that connection's token can see, and choosing one fills the form in. On the Projects page, Find more repositories on … does the same and connects the one you choose with the same token name. Only your runner uses the token; Yavaren sees the names of repositories and projects, never the token. Runners say whether they can do this when they ask for work, so the page tells you at once when no runner of yours is online or when your runner needs updating; then type the name instead, as before.
- When a connection stops working, the Connections page says so; create a new token, paste it with Replace token and choose Test connection.
Getting a token right
Next to each token, How to get this token says what it is for, where to create it, the permissions it needs, and
which other connections use the same token (it then needs their permissions too). The box warns before saving when
what you pasted has "Bearer" in front, a space, quotation marks or an address in it, or is a classic GitHub token
(ghp_…) for GitHub Copilot, which needs a fine-grained token with the Copilot Requests permission. After saving,
choose Test connection.
Changing or removing a connection
Edit (or Fix, when something is missing) opens the connection's form and takes you straight to it, with the cursor in its first field. Remove takes a connection away after you confirm. A connection that a project or an engineer still uses is not removed: the page names the project (change its connection under Projects › Edit, or end the project) or says how many engineers use it as their code agent licence (release them first). Removing a connection does not delete its tokens, which another connection may share; remove those under Organisation › Secrets.