Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Make GIST_ID as a secret #112

Merged
merged 2 commits into from
Feb 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .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: 9842e074b8ee46aef76fd0d493bae0ed
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)