https://github.com/bokub/github-stats-box

📌 Update a gist to contain your GitHub stats
https://github.com/bokub/github-stats-box

gist github github-actions pinned-gist

Last synced: 4 days ago
JSON representation

📌 Update a gist to contain your GitHub stats

• Host: GitHub
• URL: https://github.com/bokub/github-stats-box
• Owner: bokub
• License: mit
• Created: 2020-08-17T14:28:23.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-18T08:08:01.000Z (4 months ago)
• Last Synced: 2024-10-20T01:56:42.426Z (16 days ago)
• Topics: gist, github, github-actions, pinned-gist
• Language: JavaScript
• Homepage:
• Size: 47.9 KB
• Stars: 139
• Watchers: 3
• Forks: 1,402
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-pinned-gists - github-stats-box - Update a pinned gist to contain your GitHub statistics. (GitHub)
• starred - bokub/github-stats-box - 📌 Update a gist to contain your GitHub stats (JavaScript)
• project-awesome - bokub/github-stats-box - 📌 Update a gist to contain your GitHub stats (JavaScript)
• jimsghstars - bokub/github-stats-box - 📌 Update a gist to contain your GitHub stats (JavaScript)
• awesome-starred - bokub/github-stats-box - 📌 Update a gist to contain your GitHub stats (github)

README

        


  

    

  

  
github-stats-box

  
⚡️📌 Update a pinned gist to contain your GitHub stats


---

## Prep work

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

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

## Project setup

1. Fork this repository

2. From your new fork, go to **Settings > Secrets**

3. Add the following secret using the **New secret** button:

    - **GH_TOKEN:** The GitHub token generated above.

4. Go to the **Actions** tab of your fork and click the "enable" button

5. Edit the environment variables at the end of the file `.github/workflows/run.yml`

    - **GIST_ID:** The ID portion from your gist url: `https://gist.github.com/bokub/`**`1cc900d92b9acc15786d7553b46a2cdf`**.

    - **ALL_COMMITS:** Boolean value, If `true` it will count all commits instead of last year commits

    - **K_FORMAT:** Boolean value, If `true`, large numbers values will be formatted with a "k", for example `1.5k`

That's it! You gist will be updated immediately, and every 12 hours after that