Skip to content

Latest commit

 

History

History
98 lines (68 loc) · 4.42 KB

legacy-features.md

File metadata and controls

98 lines (68 loc) · 4.42 KB
Raw

Existing Jira Integration

These docs were provided by the Jira team and describe the features of the current integration

(Discovery) Documentation on how to connect Jira Cloud to GitHub

See

Installation

From within Jira Software, customers would need to

  1. go to the DVCS Accounts page within settings
  2. set up the Github connection via oAuth client ID and Code Secret
  3. Sync all repos that were added.

Note: The same method is used for Github & Github Enterprise, but an additional Host URL is required on installation. When using Atlassian Connect to host the Github application, it will need to deal with Github + Github EE itself.

We need to look at the initial sync as an important feature. This will most likely be used in the migration path from DVCS --> new integration.

The expectation would be on GitHub to re-sync everything from a historical perspective so their data is maintained in Jira Software

Configuration - Manage Repo connections

Once the customer has installed Jira Software <> GitHub together they can manage that integration with several different options. They are:

  • Link a GitHub account (link one or more accounts)
  • Delete a GitHub ccount
  • Add or remove repos from the connected GitHub account
  • Re-sync an individual repo (Soft sync or Full sync)
  • Toggle smart commits on/off per repo
  • Dropdown options for each account include...
  1. Configure default repo settings (auto sync all repos - boolean or enable smart commits for all repos - boolean)
  2. Refresh all repos
  3. Reset OAuth settings
  4. Delete

github_repolist github_blankrepolist github_re-sync github_linknewaccount github_dvcsaccountspage_syncoptions github_dvcsaccountspage_dropdownoptions github_dvcsaccountspage

(UX) Dev Panel

The development panel is maintained by Jira Software and will use the available GitHub dev info to populate the information here accordingly. It displays branches, commits, pull requests with a date.

The pull request is the only item with additional data, which is the PR status.

github_devpanel

(UX) Commits

It is expected that GitHub would interpret any commits with an issue key and then send that information to Jira Software via the new APIs provided.

The commit detail is maintained by Jira Software but the data being populated is provided by GitHub.

It is broken down by repo, then each commit message has:

  • Author
  • Commit hash
  • Commit message
  • Date
  • Files
  • File diff (expandable)

github_filediff

github_commitdetail

(UX) Branches

Branch information is displayed in branch detail modal.

It is a list of branches with the columns being:

  • Repo
  • Branch name
  • Pull request
  • Action (Create pull request)

github_branchdetail

(UX) Pull Requests

The pull request detail has each PR and columns provided are:

  • ID#
  • Title
  • Status
  • Author
  • Reviewer (can be multiple)
  • Updated

github_pullrequestdetail