Avion Knowledge Base
avion.ioSign inSign up
  • 👋Introduction
  • 👉Getting started
    • What is Avion?
    • Define your product backbone
    • Scoping and prioritizing your product
    • Creating your release plan
    • Aligning the team
    • Integrating with backlog tools
  • Docs
    • 👏Core concepts
      • Projects
        • Project team
        • Migrating to projects
      • Organizations
        • Invite a member
        • Remove a member
        • Roles
        • Transfer ownership
        • Configure your path
        • Delete your organization
    • 🚀Story map
      • Story map anatomy
      • Journeys and steps
      • Stories
      • Releases
      • Attachments
      • Tags
      • Personas
      • Labels
      • Dependencies
      • Search and filter
      • Sharing
        • Restricted links
        • Public links
      • Workflow
      • Importing data
        • Import from Excel
          • XLSX import template
        • Import from StoriesOnBoard
      • Exporting data
        • Export to PDF
        • Export to image
        • Export to CSV
        • Export to Excel
      • Rich text editor
        • Keyboard shortcuts
        • Known limitations
      • Keyboard shortcuts
      • Tips
    • 🤝Integrations
      • Backlog tools
        • Set up an integration
          • Authentication
          • Project / board selection
          • Backbone syncing
          • Map story states
          • Additional syncing options
          • Importing data
        • Sync data
          • Pushing
          • Importing
          • Attachments
          • Deleting data
        • Configuration
        • Pause an integration
        • Re-authenticate
        • Remove an integration
        • Maintenance
          • Removing stale webhooks
        • FAQs and troubleshooting
        • Services
          • Jira Cloud
            • Features
            • Set up
            • Permissions required
            • Mapping options
              • Mapping fix versions
            • Epics ~ our thoughts
            • Additional data syncing
              • Mapping custom fields
                • Company-managed projects
                • Team-managed projects
            • Migrating to epic hierarchies
            • Import using JQL
            • FAQs and troubleshooting
              • Required fields
              • Verify webhooks
              • JQL import issues
              • Workflow issues
              • Ghost cards (cards with a dashed border)
              • Limitations
              • Jira Cloud or Jira Server
          • Jira Data Center (Server)
            • Features
            • Set up
              • Creating an application link
            • Permissions required
            • Mapping options
            • Additional data syncing
              • Mapping custom fields
            • Import using JQL
            • FAQs and troubleshooting
              • Required fields
              • Ghost cards (card with a dashed border)
              • Jira Cloud or Jira Server
              • JQL import issues
          • Azure DevOps
            • Features
            • Set up
            • Permissions required
            • Import using WIQL
            • FAQs and troubleshooting
              • Verify webhooks
              • No Azure DevOps accounts were found for your user
              • Problems communicating with Azure DevOps
              • Work items couldn't be imported
              • Show epics in Azure DevOps backlog
              • Import limits
          • Trello
            • Features
            • Set up
            • FAQs and troubleshooting
          • GitHub
            • Features
            • Set up
            • Permissions required
            • FAQs and troubleshooting
              • What types of GitHub Projects are supported?
          • Linear
            • Features
            • Set up
            • Permissions required
            • FAQs and troubleshooting
      • Notifications
        • Slack
          • Set up
          • Configure notification settings
          • Remove Slack
      • Design tools and media
        • Figma
        • Adobe XD
        • Axure
        • Framer X
        • Invision Web & Studio
        • YouTube & Vimeo
      • Embed Avion
        • Confluence
        • Confluence Server
        • Notion
        • Coda
    • 🔒Security
      • Single Sign-On (SSO)
        • Setup & Configure SSO
        • Azure AD
        • Google Workspace
        • Okta
        • OpenID Connect
      • Two-factor authentication (2FA)
    • ❓FAQs
      • Attachment file types
    • 💳Billing
      • Plans and pricing
      • Legacy plans
      • Free trials
      • Billing and payments
      • Change your plan
      • Cancel your plan
      • Refunds
      • Startup, student and educational discount
  • Story Mapping Guides
    • How To Story Map — A Simple Example
    • Advantages of Story Mapping
    • A Recommended Workflow
Powered by GitBook
On this page
  • Authentication
  • Project type selection
  • Repo / Organization selection
  • Project selection
  • State mapping
  • Import from GitHub
  1. Docs
  2. Integrations
  3. Backlog tools
  4. Services
  5. GitHub

Set up

Last updated 1 year ago

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 .

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. .

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.

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

Just to help you visualise this, here are the two states in either tool:

Import from GitHub

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.

If you are unsure which project type to select, please refer to the page.

Map your Avion to your GitHub states. .

Import your existing project backlog from GitHub. .

🤝
What Types of GitHub Projects Are Supported?
workflow
Advice and info
Advice and info
permissions required
More info