auto-timesheet

auto-timesheet

Add redmine timesheet automatically and periodically.

Important: This package is pre-configured for Cubet Technolabs Policies. If you need to configure this app for your workstation, please rise an issue and I'll reach you back.

Created and maintained at free times for fun.

Why?

• Adds activities to timesheet automatically and periodically.
• Integrated with your Github repo. So activity messages are constructed from your commit messages.

Currently, this package only supports Github.

Install

npm i -g auto-timesheet

verify with auto-timesheet --version.

Configure

auto-timesheet conf

It opens up a config file. Alter it and save. Make sure you didn't made any syntax mistakes with the opened json file.

By default it will open the editor mentioned in the $EDITOR env_var. If none, be prepared for vi.

some important conf file properties

• projectId : The timesheet project id in which you are working on. You should find this by inspecting the web interface. If you need any assistance, feel free to open an issue.
• activityInterval : Interval in milliseconds.
• defaultIssue : If auto-timesheet couldn't extract any issues from your commit messages, this issue will be used.
• config.git.commitAuthorEmail : email of the committer. commit messages are extracted based on this email.
• config.git.url: Github api url to fetch commits of your repo.
• issueMatchingInsensitivity [Recommended 3] : For best results, this should be an integer in between 0 and 10. Lesser the value, it is more likely that the package will create new issues. Higher the value, the package will try to match the extracted issue with existing issues and if both are matching (the degree of matching is based on the issueMatchingInsensitivity value), the existing issue will be reused. In other words, accuracy of the matchness is based on this value. Lesser the value means more accurate and higher the value means less accurate.

Usage

modify your future commit messages:

use star-tags (*thisIsStarTag) to mention the timesheet-issue/issues you are addressing with this commit. An example commit message be like:

Improves *login security and updates *documentation 

Here login and documentation are timesheet issues. The package will choose one randomly and create/use that issue for this commit message.

start application

auto-timesheet start

Found any issues/ need help?

Please report it at github issues

Licence

MIT © Vajahath Ahmed