Go To Sleep-a-tron Github Actions Hackathon Submission

Frooth — Sun, 23 Aug 2020 16:10:54 +0000

My Workflow

Name: FraserTooth/go-to-sleep
Description: This Github Action will use the timestamps in commit logs to figure out whether someone is doing work past their bed time...and tell them off!
Being Used: On itself...🤣
Github: Link

Submission Category:

Wacky Wildcards (I think...)

Yaml File or Link to Code

FraserTooth / go-to-sleep

Stop coding and go to sleep!

The Github Go-To-Sleep-a-Tron Action

Stop coding and go to sleep!

(Example Commit with Message)[https://github.com/FraserTooth/go-to-sleep-action/commit/a46d6fd23defa2b5b9c974cebbc843eeb01a5ff9]

Inputs

`GITHUB_TOKEN`

Required
Just put ${{ secrets.GITHUB_TOKEN }} and it should work fine.

`custom_mesage`

Optional
Put your custom message as a HTML formatted string:
e.g. custom_message: "Oh dear, its very late where you are.\nWe appreciate your hard work but maybe you should go to bed."

Default: "Its quite late, maybe you should go to sleep!"

`timezone`

Required for any events other than commits (push)
Enter your team's timezone in the ISO format (+/-)hh:mm:
e.g. timezone: "+09:00"

How to use

If you do not have any Github actions already set up in your repo, start by creating a .github/workflows folder.

Inside your workflows folder, create a new .yml file, for example main.yml and copy the following lines:

on
  [
    push,
    pull_request,                 # Slightly Supported
    pull_request_review,          # Not Supported
    pull_request_review_comment,  # Not Supported
    issues,

…

View on GitHub

Link to Release

Additional Resources / Info

Explanatory DEV.to Post

Combatting Burnout with the "Go to Sleep-a-tron"

Frooth — Sun, 23 Aug 2020 16:08:50 +0000

A couple of weeks ago, I saw two things:

First, I saw a tweet from Charlie Gerard showing her great project to combine ML and Github culture to create a Github action to auto-admonish toxic comments on PRs and the like.
// Detect dark theme var iframe = document.getElementById('tweet-1295096920168452099-776'); if (document.body.className.includes('dark-theme')) { iframe.src = "https://platform.twitter.com/embed/Tweet.html?id=1295096920168452099&theme=dark" }

Then I saw the Actions Hackathon challenge announced and thought I should give it a go.

So, inspired by Charlie's idea of making Github culture a little better (and no small amount of using her code-base to figure out Github Actions), I hereby present my very silly Github Action go-to-sleep aka The Go-To-Sleep-a-tron Hackathon Submission

FraserTooth / go-to-sleep

Stop coding and go to sleep!

The Github Go-To-Sleep-a-Tron Action

Stop coding and go to sleep!

Example Commit with Message

Inputs

`GITHUB_TOKEN`

Required
Just put ${{ secrets.GITHUB_TOKEN }} and it should work fine.

`custom_mesage`

Optional
Put your custom message as a HTML formatted string:
e.g. custom_message: "Oh dear, its very late where you are.\nWe appreciate your hard work but maybe you should go to bed."

Default: "Its quite late, maybe you should go to sleep!"

`timezone`

Required for any events other than commits (push)
Enter your team's timezone in the ISO format (+/-)hh:mm:
e.g. timezone: "+09:00"

How to use

If you do not have any Github actions already set up in your repo, start by creating a .github/workflows folder.

Inside your workflows folder, create a new .yml file, for example main.yml and copy the following lines:

on
  [
    push,
    pull_request,                 # Slightly Supported
    pull_request_review,          # Not Supported
    pull_request_review_comment,  # Not Supported
    issues,                       # Not

…

View on GitHub

In short, this Action will simply check the time of the commits pushed to the repo, and will post a comment to the commit if it was committed 'overnight', from the perspective of the committer's timezone. It will work on any branch and the message you send can be customised 😁

I've currently set it to trigger before 9am and after 7pm, because thats when you should be cooking, eating, sleeping and reading terrible dev.to articles instead of doing more work!

My intended user would be companies who want to discourage overworking, so if you want me to keep working on this, let me know!

How It Works

For the most part I followed the Official Guides and Charlie's Code but in general my code does the following:

Takes in the Action Data and Inputs
If its a Commit Action ('Push') it will check each commit for a timestamp field. Which contains the time, and thankfully, the timezone in which the commit was made.
If the time is before 9am or after 7pm in a given day, a comment will be posted on the commit, using the custom or default message.

Pretty simple right, but there were some gotchas...

The Gotchas

Timestamps in Github

I initially wanted to have this trigger for any commentable Github action (Open PR, PR Review, Issues...) but for some reason, the only timestamp within the data provided both within the Github actions data and the Github API that contains the commiter's timezone is "commit data" inside Github Actions input data. Otherwise, the time is only available in UTC 🤷‍♀️ (you can check my test data for examples of the data given)
Naturally, the next step is to allow the addition of user-specific timezones as an input to the workflows/main.yml file, but this removed some of the magic and wasn't as fun 😔

Timezones in Javascript

Timezones are a known pain point in programming, and yes, there are some good libraries like moment.js to help with this...in a normal situation.
The issue I had, was that these timezone libraries are built with the understanding that you will know where the person is before you need to make the conversion, such as the country.
As far as I can tell, it's not possible to find out the location of a given Github user (profile location is too 'custom' and I found no usable data in the API), and plus...I didn't really need to care 😂. I already had the timezone, so I could just figure out if they were up late, regardless of their actual location.
However, there isn't an easy way to retain 'original timezone' when parsing dates with these libraries, so upon parsing the datestring, I would be stuck in UTC 😒
In the end, I just ended up using Regex to extract the timezone section of the string and do the 'is it bedtime' math manually. It was kind of painful, but I suppose I learnt something about dates in Javascript 😵...or something...

Github Actions Dev Cycle

Another gotcha was that its kinda annoying to get Github actions running locally, so in developing this I was stuck making commits and pushes to check the functionality...
There is a rather neat tool called act which allows you to run Github actions locally 🙌 but I could only figure out how to get them from a remote source, so I just had to push the changes to Github anyway 😐
While writing this, I found an Issue in the repo that suggests getting local actions is doable, so that would be my next TODO.

Future Feature Ideas

Aside from some small obvious things, if people think this idea is interesting (and encourage me to improve it!), I think these additions might be useful:

Add more Github Action types (despite the lack of magic)
- There might be a clever way to figure out a commenter/contributer's timezone, but short of keeping a database I'm not sure what it would be outside of...
Add a 'per Github contributor' timezone
- This would solve problem one, but it strikes me as clunky 🤔
Allow configuration of posting to a basic Slack webhook or sending an Email to send notifications outside of Github
- One key problem with this is that I never read emails from Github or look at the notifications 🤣, sending messages externally might be useful for a Manager to keep an eye out for unhealthy behaviour.

Cheers M'Dears

All in all, thank you for reading, check out my Github for other projects and my Twitter for inconsistent mutterings. Cheerio!

Forem: Frooth

Go To Sleep-a-tron Github Actions Hackathon Submission

My Workflow

Submission Category:

Yaml File or Link to Code

FraserTooth / go-to-sleep

Stop coding and go to sleep!

The Github Go-To-Sleep-a-Tron Action

Inputs

GITHUB_TOKEN

custom_mesage

timezone

How to use

Additional Resources / Info

Combatting Burnout with the "Go to Sleep-a-tron"

FraserTooth / go-to-sleep

Stop coding and go to sleep!

The Github Go-To-Sleep-a-Tron Action

Inputs

GITHUB_TOKEN

custom_mesage

timezone

How to use

How It Works

The Gotchas

Timestamps in Github

Timezones in Javascript

Github Actions Dev Cycle

Future Feature Ideas

Cheers M'Dears

`GITHUB_TOKEN`

`custom_mesage`

`timezone`

`GITHUB_TOKEN`

`custom_mesage`

`timezone`