Skip to content

samisayegh/automatic-timesheet

Repository files navigation

automatic-timesheet

A tool that automatically fills your timesheet based on your commits.

Setup

You will need to have node and npm installed. You can download it here. Once ready,

  1. Clone the repo.
  2. Setup the project: npm run setup
  3. In the .env file, add your Coveo email, and a Jira token that can be generated here.

Logging time

To log time for current day, run:

npm run log

Alternatively, pass a date formatted as YYYY-MM-DD to log time for a previous day.

npm run log -- 2020-10-23

To log time for a range of dates, pass a start and end date.

npm run log -- 2020-10-23 2020-10-26

To automate the process, set up a cron-job on your computer to run at the end of your working day (e.g. 5pm).

Available Scripts

  • npm run log - Logs time.
  • npm run create:config - Generates an .env file if it does not already exist.
  • npm run build - transpiles TypeScript to JavasScript.

Limitations

  • You must be assigned to the jiras for the tool to find them.
  • The tool uses commits as proof-of-work. If you do not use git commits as part of your job, the tool will not log time for your associated jiras.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published