https://github.com/maxam2017/productive-box

Are you an early 🐤 or a night 🦉? Let's check out in gist
https://github.com/maxam2017/productive-box

awesome-pinned-gists pinned-gist

Last synced: about 1 month ago
JSON representation

Are you an early 🐤 or a night 🦉? Let's check out in gist

• Host: GitHub
• URL: https://github.com/maxam2017/productive-box
• Owner: maxam2017
• License: mit
• Created: 2020-04-15T22:32:58.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-14T15:10:26.000Z (4 months ago)
• Last Synced: 2024-10-22T22:32:46.830Z (about 2 months ago)
• Topics: awesome-pinned-gists, pinned-gist
• Language: TypeScript
• Size: 528 KB
• Stars: 501
• Watchers: 4
• Forks: 7,067
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-pinned-gists - productive-box - Update a pinned gist to contain your most productive hours during the day. (GitHub)
• stars - productive-box
• stars - productive-box

README

        
> [!CAUTION]

> If you upgrade to v1.1.5+, please remember to:

>

> 1. move the **GIST ID** to the Secret

> 2. move the **TIMEZONE** to the Repository variable

>    For details, refer to the third point in [Project Setup](https://github.com/maxam2017/productive-box/tree/master?tab=readme-ov-file#project-setup).

>

> p.s. when you see this notice in the README of your forked repository, it means you have upgraded to v1.1.5



  

    

  

  
📌✨productive-box




   

   

   

   





   Are you an early 🐤 or a night 🦉?

   


   When are you most productive during the day?

   


   Let's check out in gist!



---

> This project is inspired by an awesome pinned-gist project.


> Find more in https://github.com/matchai/awesome-pinned-gists

## Overview

This project uses GitHub graphQL API to get the commit histories and write into the gist by [rest.js](https://github.com/octokit/rest.js#readme)

## Setup

### Prep work

1. Create a new public GitHub Gist (https://gist.github.com/)

1. Create a token with the `gist` and `repo` scope and copy it. (https://github.com/settings/tokens/new)

   > enable `repo` scope seems **DANGEROUS**


   > but this GitHub Action only accesses your commit timestamp in the repositories you contributed.

### Project setup

1. Fork this repo

1. Open the "Actions" tab of your fork and click the "enable" button

1. Go to the repo **Settings > Secrets and variables** > **Actions**,

   add the following secrets / variables:

   | Type | Name | Description |

   |---------------------------------|--------------------|---------------------------------------------------------------|

   | Repository Secrets | **GH_TOKEN** | The GitHub token generated above. |

   | Repository Secrets | **GIST_ID** | The ID portion from your gist URL, e.g., `9842e074b8ee46aef76fd0d493bae0ed`. |

   | Repository Variable | **TIMEZONE** | The timezone of your location, e.g., `Asia/Taipei` for Taiwan, `America/New_York` for America in New York, etc. |

   Below is the final screenshot: (Click the image for a clearer view.)

   |Repository Secret|Repository Variable|

   |:-:|:-:|

   |||

1. Manually run the workflow for the first time or wait for the scheduled run. (The workflow will run every day at 00:00 UTC.)

1. [Pin the newly created Gist](https://help.github.com/en/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile)

### How to run the workflow manually

1. Go to the "Actions" tab on your fork

1. Select the "Update gist" workflow

1. Click the "Run workflow" button