From 517d67ef7bfa35fae3b4a212c32367c534bee6e1 Mon Sep 17 00:00:00 2001 From: Hong-Kuan Wu Date: Sat, 17 Feb 2024 02:02:44 +0800 Subject: [PATCH] v1.1.5 (#114) * chore: move timezone to repository var * docs: add warning block for gist id / timezone setting for v1.1.5 * chore: v1.1.5 --- .github/workflows/schedule.yml | 2 +- README.md | 24 ++++++++++++++++++------ package.json | 2 +- 3 files changed, 20 insertions(+), 8 deletions(-) diff --git a/.github/workflows/schedule.yml b/.github/workflows/schedule.yml index 2c19f2865..0804345c1 100644 --- a/.github/workflows/schedule.yml +++ b/.github/workflows/schedule.yml @@ -15,4 +15,4 @@ jobs: env: GH_TOKEN: ${{ secrets.GH_TOKEN }} GIST_ID: ${{ secrets.GIST_ID }} - TIMEZONE: Asia/Taipei + TIMEZONE: ${{ vars.TIMEZONE }} diff --git a/README.md b/README.md index 9d8effd9c..eb4fe5613 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ +> [!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 +

screenshot @@ -25,6 +34,7 @@ > 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 @@ -40,10 +50,12 @@ This project uses GitHub graphQL API to get the commit histories and write into 1. Fork this repo 1. Open the "Actions" tab of your fork and click the "enable" button -1. Go to the repo **Settings > Secrets**, add the following environment variables: - - **GH_TOKEN:** The GitHub token generated above. - - **GIST_ID:** The ID portion from your gist URL, e.g. `https://gist.github.com/maxam2017/`**`9842e074b8ee46aef76fd0d493bae0ed`**. -1. (Optional) Edit the [environment variable](https://github.com/maxam2017/productive-box/blob/master/.github/workflows/schedule.yml#L18) - in `.github/workflows/schedule.yml`: - - **TIMEZONE:** The timezone of your location, e.g. `Asia/Taipei` for Taiwan, `America/New_York` for America in New York, etc. +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. | + 1. [Pin the newly created Gist](https://help.github.com/en/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile) diff --git a/package.json b/package.json index d7249f016..e2c3cd067 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "productive-box", - "version": "1.1.3", + "version": "1.1.5", "description": "Are you an early 🐤 or a night 🦉? Let's check out in gist", "author": "maxam2017", "license": "MIT",