Log time from Github
Our Github App 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!
You can install the Github App by clicking here, or by following the steps below:
- Click on Integrations & Apps in the green navigation menu.
- On the Integrations, Connected Apps & API page, select the Integrations tab.
- Look for the Github integration, and click the Connect... button to install the Github App
Once you've installed the Github App, you can configure which repositories it has access to from the Installed GitHub Apps section of your Github Organization
By default, the Github App will only log time for repositories that have a name that exactly matches a project name in Freckle. That includes any punctuation such as spaces, dashes, & upper or lower case letters.
Not to worry though! You can link a Freckle Project to a Github Repository by following the steps below:
- Open the Project Settings
- Click the Integrations tab
- Search for the Github Repository, then click Save & Close
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.
- [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.
git commit -m "fixing that #bug [f:1.5h]"
The f:xx part will not show up as part of the description in Freckle.
- It’s critical that the project name is exactly the same as it is in Freckle. That includes any punctuation such as spaces, dashes, & upper or lower case letters. You can always manually link a Freckle Project to the Github Repository by following the steps above
- 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.