Log time from GitHub

Our GitHub integration will enable you to log time directly from git commit messages. If you find the command line cool, and don't want to lift your hands or even switch apps to log time, read on!

To set up your Github configuration, you'll first need your API token. An API token is an automatically generated string of numbers an letters that's unique to your personal Freckle account and sign in. Each person in Freckle has their own API token.

Important: Your API token is like a password, so treat it like one- don't share it with anyone! Only use it in other apps to provide access to Freckle.Click on Integrations & Apps in the green sidebar menu.Click the API tab.

  1. Click on Integrations & Apps in the green navigation menu.
  2. On the Integrations, Connected Apps & API page, select the Freckle API tab. 
  3. Look for API v1 Token (note: you'll need the API v1 Token, Personal Access Tokens don't work) and click on Settings… 
  4. In the popup, click the box to reveal your token. You can select it and copy it to your clipboard.

Once you have your  API token, login to your Github account and follow these easy steps!

  1. Go to the repository you'd like to link Freckle to.
  2. Click on the 'Settings' tab on the right hand side of the screen.
  3. Click on the'Webhooks & Servics' tab in the sidebar on the left hand side of your screen.
  4. Choose Freckle from the list of "Available Service Hooks" that appears.
  5. Fill out the subdomain, the project and token fields.
  6. After you've filled out these three fields, check the "Active" checkbox.
  7. Once you've completed all of the configuration steps, click the green 'Update Service' button!

Logging time from your commit messages

Add time to your commit message using  square brackets containing the key f: followed by the amount of time you'd like to log.

For example:

  • [f:5m] will log 5 minutes
  • [f:1] will also log 1 hour
  • [f:1h] will also log 1 hour
  • [f:5] will log 5 hours
  • [f:10] will log 10 minutes

The  [f:xx] syntax provides the same smart time parsing features as the Quick Entry box.

Here's a detailed brakdown of how you can specify time:

  • m, min, mins, minute, minutes – Sets the time in minutes (i.e. 15m)
  • h, hr, hrs, hour, hours – Sets the time in hours (i.e. 1h)
  • d, day, days – Sets the time in working days (i.e. 1d would be 8 hours)
  • 4 – Sets the time in hours 
  • 4,15 / 4.15 / 4:15 – Sets time in hours and minutes

The rest of your message will be used to  create tags and description. The syntax is exactly the same as the TAGS OR DESCRIPTION field in the Quick Entry box.

For example:

git commit -m "fixing that #bug [f:1.5h]"

The  f:xx part will not show up as part of the description in Freckle.

Troubleshooting

  • It’s critical that the project name is exactly the same as it is in Freckle. That includes any punctuation such as spacesdashes, & upper or lower case letters.
  • The email addresses for each GitHub user account must also match the email addresses we have for that person in Freckle.
  • For contractors and coworkers, the person must be assigned to the project that the GitHub integration is set up for.