Skip to content
activity

GitHub Action

productive-box

v1.2.0 Latest version

productive-box

activity

productive-box

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

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: productive-box

              
  uses: maxam2017/productive-box@v1.2.0
Learn more about this action in maxam2017/productive-box

Choose a version

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.

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

screenshot

📌✨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

Setup

Prep work

  1. Create a new public GitHub Gist (https://gist.github.com/)
  2. 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

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

  3. 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

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

  5. Pin the newly created Gist

How to run the workflow manually

  1. Go to the "Actions" tab on your fork
  2. Select the "Update gist" workflow
  3. Click the "Run workflow" button