Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Integrating GitHub and Timesheets by Tempo

...

Timesheets by Tempo lets you log your time faster in Jira by using your GitHub activity to provide suggestions in Timesheets.

When you commit or checkout with git, the Tempo Time Tracking Extension posts an event to the Tempo API containing the current branch name and timestamp. If you commit files, a commit message is also posted.

This activity feed records the time you spend on coding activities and any changes made to files in your git repositories, leading to better suggestions for logging time in Tempo Timesheets.

Tip

We recommend including an issue key in the branch name or the commit message.

Before you begin

You must have one of the following roles in your GitHub organization:

  • The app manager role or

  • An organization owner role

Install Tempo Time Tracking on GitHub

  1. Select Apps in the Tempo sidebar.

  2. In the GitHub Integration tile, click Install. You are redirected to the GitHub Marketplace to install the app.

  3. Follow the onscreen directions to install the Tempo Time Tracking app in GitHub.

When installed, individuals in your organization can connect to GitHub in their My Work settings to link their GitHub and Tempo accounts and receive suggestions based on their GitHub activities. See Connecting and Disconnecting Your Activity Providers for more informationpopulates the Activities Feed in My Work with potential worklogs based on actions performed with GitHub. This allows team members to log the time they spend working on code quickly without needing to track their time manually.

The app reads data from the following events, captured through GitHub’s webhooks:

  • Create

  • Push

  • Commit

  • Pull Request

The data is used to associate the work with a Jira issue and to estimate how much time is spent working on coding tasks for the issue.

A GitHub admin must add the Tempo Time Tracking app to their GitHub organization. They can restrict the app to specific repositories or allow time tracking in all of the code bases. Members of the organization can then connect their accounts so their time can be tracked. Tempo Administrators can also enable time tracking in GitHub on behalf of team members.

We recommend that you include the Jira issue key in your commit messages to ensure that the app associates the work with the correct issue.

Before you begin

Connect Your GitHub Account

  1. Navigate to My Work.

  2. Open the Settings menu.

    ts-mywork-settings.jpgImage Added
  3. Under Activities, select Settings.

  4. Click the Edit icon next to GitHub.

    ts-provider-github.jpgImage Added
  5. When prompted, click Connect GitHub Account.

    ts-individual-connect-github.jpgImage Added

    You may be prompted to log in to your GitHub account.

  6. After you authenticate your account, you are prompted to authorize the Tempo Time Tracking app.

Your Activity Feed can now be populated with actions you perform with GitHub.

Verify Your Connection

  1. Navigate to My Work.

  2. Open the Settings menu, and select Settings.

  3. Click the Edit icon next to GitHub.

  4. The GitHub connection page displays your status if you’re connected.

    ts-github-connection-status.jpgImage Added

Update Access

  1. Navigate to My Work.

  2. Open the Settings menu, and select Settings.

  3. Click the Edit icon next to GitHub.

  4. In the GitHub connection page, click Configure.

    ts-github-connection-config.jpgImage Added
  5. Click Configure next to your organization.

    github-update-config.jpgImage Added
  6. Authenticate your GitHub account.

  7. Modify the repositories that Tempo Time Tracking can access.

    github-repo-access.jpgImage Added
    1. If you want to leave the repository access as it is, close the browser window.

  8. When complete, update your access.

Disconnect Your Account

  1. Navigate to My Work.

  2. Open the Settings menu, and select Settings.

  3. Click the Edit icon next to GitHub.

  4. Click Disconnect.

    ts-github-connection-status.jpgImage Added

After you’ve disconnected your account from GitHub, activities you perform with GitHub are no longer tracked and don’t appear in your Activities Feed. Worklogs you’ve created from a GitHub activity remain, but the activities are removed from your feed.