Skip to content

Commit

Permalink
Make GIST_ID as a secret (maxam2017#112)
Browse files Browse the repository at this point in the history
* Update schedule.yml

* Update README.md
  • Loading branch information
AlexV525 authored and ickynavigator committed May 19, 2024
1 parent 0d81051 commit a077a97
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/schedule.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ jobs:
uses: maxam2017/productive-box@master
env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
GIST_ID: f482521bf654778a045a7446366d24e2
TIMEZONE: Asia/Famagusta
GIST_ID: ${{ secrets.GIST_ID }}
TIMEZONE: Asia/Taipei
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,29 +21,29 @@

---

> This project is inspired by an awesome pinned-gist project.<br/>Find more in https://github.com/matchai/awesome-pinned-gists
> This project is inspired by an awesome pinned-gist project.<br/>
> 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**<br/>
> but this GitHub Action only accesses your commit timestamp in repository you contributed.
> 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. Edit the [environment variable](https://github.com/maxam2017/productive-box/blob/master/.github/workflows/schedule.yml#L17-L18) in `.github/workflows/schedule.yml`:

- **GIST_ID:** The ID portion from your gist url: `https://gist.github.com/maxam2017/`**`9842e074b8ee46aef76fd0d493bae0ed`**.
- **TIMEZONE:** The timezone of your location, eg. `Asia/Taipei` for Taiwan, `America/New_York` for America in New York, etc.

1. Go to the repo **Settings > Secrets**
1. Add the following environment variables:
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. [Pin the newly created Gist](https://help.github.com/en/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile)

0 comments on commit a077a97

Please # to comment.