Tool to automatically add working hours of an employee in BambooHR Platform

Home Page: https://dominguezcelada.github.io/bamboohr-update-working-hours-automatically/

TypeScript 78.01% JavaScript 21.99%

puppeteer bamboohr typescript github-actions

bamboohr-update-working-hours-automatically's Introduction

BambooHR Working Hours automation

Automatically add working hours of an employee in BambooHR

⚠️ Unmaintained ⚠️

My company stopped using BambooHR so this project is not maintained anymore

Context

The company I'm currently working for requires to fulfill a form every day of the month with the amount of hours worked in BambooHR platform. This is due the new law the Spanish government created a few months ago. Apparently BambooHR plugin to add Working Hours does not offer settings to automate or add by default values to this form.

I first tried to interact with BambooHR API but it requires a Private Key which is not possible to be provided by my current company right now.

That's why I opt for a headless solution to add the manual interaction a user would do so it can be automated.

Tools/Language/Technologies

TypeScript
GitHub Actions
- from Monday to Friday at 8am (GMT)
Puppeteer

Project Structure:

.github/workflows/bamboohr-puppeteer.yml: Simulate UI interactions with BambooHR UI through headless browser solution (Puppeteer)
src/index.ts: File run by Puppeteer to interact with BambooHR UI site to finally register Working Hours on BambooHR's Working Hours Plugin
src/bamboo-hr-interactions/*: Different interactions taken over BambooHR UI Components with Puppeteer (click, type...)

Setup

Fork this repository in your GitHub Account ^*
Add the following KEY-VALUES as secrets on the repository you plan to run this Github Action:
- COMPANY_BAMBOOHR: Company's subdomain under BambooHR to access your company's BambooHR site: https://<COMPANY_BAMHOOHR>.bamboohr.com
- USER_BAMBOOHR: BambooHR's Username of the employee you want to automate his/her working hours
- PASSWORD_BAMBOOHR: Password associated to previous username
Wait until next working day (Monday-Friday) at 8AM GTM^** to get GitHub Action automatically triggered

_{*This tool is in alpha stage so it is not available in Github Marketplace yet. As soon as it is considered as ready to use, it will be published} _{**You can find online converters from your local time to GTM. Also, at www.google.com you can just type: "gmt convert" and magic will happen 😎}

bamboohr-update-working-hours-automatically's People

Contributors

Watchers

bamboohr-update-working-hours-automatically's Issues

To not run Github Action in test when it's Prettier Github App commit

To not run if it's holiday

Do not add working hours if it's national/regional/local holiday

Add Tests

Unit Tests
Integration Tests

To split `Build` step and `Puppeteer` step in Pipeline

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
It would be nice to split this step so the Build part becomes a check run for Pull Requests

Describe the solution you'd like
A clear and concise description of what you want to happen.
To split Build step (TypeScript compilation)

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
none

To consider days off properly

To not run when an employee has day off
To apply proper schedule when it has special schedule (morning shift, late shift...)

To run workflow when is a testing branch

To run Puppeteer workflow on:

schedule
push on branches with name matching test-** pattern

Puppeteer: Try to make selectors of components more robust

To remove unused workflow from repository: Lint

Migrate project to TypeScript

lint-action does not support "schedule" GitHub events

Describe the bug
A clear and concise description of what the bug is.
Github Action fails when you run it in schedule event

To Reproduce
Steps to reproduce the behavior:
https://github.com/dominguezcelada/bamboohr-update-working-hours-automatically/runs/1642543064?check_suite_focus=true

There are some unhandled promises not throwing

i.e. https://github.com/dominguezcelada/bamboohr-update-working-time-job-settings/runs/1632341781?check_suite_focus=true

Use Node's --unhandled-rejections=strict

To run Github Action when Pull Request is labeled with `test-puppeteer`

Do not run Puppeteer when is PR but run the rest of Steps in Pipeline

Describe the bug
A clear and concise description of what the bug is.
Right now any PR is running Puppeteer and it should not

To Reproduce
Steps to reproduce the behavior:

Open any PR
Check Actions
Action is not skipped

Expected behavior
A clear and concise description of what you expected to happen.
Do not run Puppeteer when is PR but run the rest of Steps in Pipeline

Puppeteer workflow should fail when Puppeteer fails

With the latest changes in #41, Puppeteer is exiting successfully even if the execution failed

Example: https://github.com/dominguezcelada/bamboohr-update-working-time-job-settings/runs/1612139237?check_suite_focus=true

Add Prettier

Preventing ESLint and formatting errors from being committed

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Prevent ESLint and formatting errors from being committed

Describe the solution you'd like
A clear and concise description of what you want to happen.
https://www.robertcooper.me/using-eslint-and-prettier-in-a-typescript-project

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
To use a Github Action to run it instead of local machine of the developer