lang-box

lang-box copied to clipboard

lang-box

💻 Update a pinned gist to contain languages of your recent commits in GitHub

This project is inspired by waka-box, productive-box and metrics.
📌✨ For more pinned-gist projects like this one, check out: https://github.com/matchai/awesome-pinned-gists

This project gets your recent commits from your activities fetched from GitHub API, and process them with linguist to show the percentage of each languages used. This project also calculate how many lines of codes were added/removed per language.

Setup

Prep work

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

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

   • And if you would like to include commits in private repos, also add repo scope.

     Enable repo scope seems DANGEROUS, but secrets are not passed to workflows that are triggered by a pull request from a fork (https://docs.github.com/en/actions/reference/encrypted-secrets)

Project setup

1. Fork this repo, or create a repository from template by clicking here or the Use this template button on this project.

   • If you added repo scope above, it's recommended to create private repository.

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

3. Edit the environment variable in .github/workflows/run.yml:

   • GIST_ID: The ID portion from your gist url: https://gist.github.com/inokawa/64dacee1c6c93cdbcf48548f6598f823.

4. Go to the repo Settings > Secrets

5. Add the following environment variables:

   • GH_TOKEN: The GitHub token generated above.

6. Pin the newly created Gist