Set up

Authentication

Avion uses the highly secure OAuth 2 protocol to allow us to authenticate as you with GitHub. This allows Avion to see your repos, projects and organizations.

Before you dive in, please note that the user that you choose to authenticate with GitHub must be either the owner of the repo — if you're syncing to a repo project, or an owner of the organization — if you're syncing to an organization project.

A repo can only have one owner, but an organization can have multiple.

Read about permissions required.

You might choose to create a specific integration user that can be controlled by a trusted member of your business. This mitigates against the situation where you have to delete a user that Avion is authenticated with if a person leaves your business. More info.

You might need to allow pop-ups if you browser blocks them, as Avion uses a pop-up window to authenticate with GitHub.

Project type selection

This stage is only applicable to classic projects.

If you are unsure which project type to select, please refer to the What Types of GitHub Projects Are Supported? page.

Repo / Organization selection

This stage is only applicable to classic projects.

Depending on which project type you selected, you will now need to select either a repo or an organization that contains the project you are looking to sync to.

Project selection

Select the particular project you would like Avion to import issues and cards from, push stories to and sync up with.

State mapping

Map your Avion workflow to your GitHub states. Advice and info.

Just to help you visualise this, here are the two states in either tool; bear in mind that ZenHub has a similar, but very slightly different layout to GitHub Projects.

Import from GitHub

Import your existing project backlog from GitHub. Advice and info.

Please note the following:

• Closed issues will not be imported

• Only issues that are on the project board that are not in a triage state will be imported

• Closed milestones will not be imported (specific to repo-based classic projects)

You can re-import again later, so any issues that may get added in GitHub can always be pulled back into Avion.