https://github.com/npanuhin/github-language-bar
👷🚧 Work in progress! ⌛ Had to make this repository public before release. 🚧 Stay tuned!
https://github.com/npanuhin/github-language-bar
github-actions github-api github-readme github-readme-profile
Last synced: about 2 months ago
JSON representation
👷🚧 Work in progress! ⌛ Had to make this repository public before release. 🚧 Stay tuned!
- Host: GitHub
- URL: https://github.com/npanuhin/github-language-bar
- Owner: npanuhin
- License: mit
- Created: 2023-01-11T22:32:46.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-07T22:54:48.000Z (4 months ago)
- Last Synced: 2025-01-07T23:20:00.984Z (4 months ago)
- Topics: github-actions, github-api, github-readme, github-readme-profile
- Language: Python
- Homepage:
- Size: 1.09 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.dev.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
GitHub Language Bar
## Features
TODO
## Wanna add one to you profile?
> Just two steps, two minutes! ⏱
1. Go to your repository and create a workflow file named `language_bar.yml` under `.github/workflows` folder. Paste the following content inside:
```YAML
name: GitHub Language Bar
on:
push: # Run every time config or README changes
paths:
- README.md
- .github/workflows/*
schedule: # Run every day at to 4:38 AM
- cron: 38 4 * * *
workflow_dispatch: # Run with a button in the Actions tab
jobs:
language_bar:
name: Create GitHub Language Bar
runs-on: ubuntu-latest
steps:
- name: Create Language Bar
uses: npanuhin/GitHub-Language-Bar@master
```
2. Add this mark anywhere in your README[^anywhere_in_readme]:
```html
```
3. You are all set! Your bar should appear in a few seconds.
The next steps are optional, but I suggest [enabling private repositories](#enable-private-repositories) so that people can see your true language usage across all repositories, not just the public ones.
You can also [customize](#Customize) your new language bar in various ways. If you have any questions, [don't hesitate to ask!](https://github.com/npanuhin/GitHub-Language-Bar/issues/new)
## Enable private repositories
1. Generate a new personal access token with access to all your current and future repositories:
- Go to https://github.com/settings/personal-access-tokens/new and fill the following fields:
- **Token name:** whatever you like, e.g. `Language-Bar-token`
- **Expiration:** `No Expiration` ⚠
- **Repository access:** `All repositories` ⚠
- **Permissions:** open up `Repository permissions`:
- **Contents:** set to `Read-only`
- **Metadata:** set to `Read-only`
- Scroll all the way down and click `Generate token`
- Finally, copy the generated token to the clipboard
2. Add this token to your repository:
1. Go to the repository, where the target `README.md` file is located
2. Open up the repository settings
3. On the left side select `Secrets and Variables` -> `Actions`
4. Click on `New repository secret`
- **Name:** exactly `LANG_BAR_PAT`
- **Secret:** Paste the copied in the previous step token from the clipboard
- Click `Add secret`
3. Add the following parameter to the workflow file (`.github/workflows/language_bar.yml`):
```DIFF
steps:
- name: Create Language Bar
uses: npanuhin/GitHub-Language-Bar@master
+ with:
+ gh_token: ${{ secrets.LANG_BAR_PAT }} # Token is used to fetch private repositories
```
All together it should look like this
```YAML
name: GitHub Language Bar
on:
push: # Run every time config or README changes
paths:
- README.md
- .github/workflows/*
schedule: # Run every day at to 4:38 AM
- cron: 38 4 * * *
workflow_dispatch: # Run with a button in the Actions tab
jobs:
language_bar:
name: Create GitHub Language Bar
runs-on: ubuntu-latest
steps:
- name: Create Language Bar
uses: npanuhin/GitHub-Language-Bar@master
with: # Token is used to fetch private repositories
gh_token: ${{ secrets.LANG_BAR_PAT }}
```
> [!WARNING]
> If you enable private repositories, the script will collect and log some information about them. Since your profile repository is almost always public, everyone can see your README source and workflow logs (Actions tab). **By default, apart from the bar itself, others cannot learn anything about your private repositories.** However, be careful when using additional settings:
> - *If [log is turned on](#log)*: number of bytes per language for each repository is logged
> - *If you use [`replace`](#replace_setting) or [`hide`](#hide_setting) options* in the `repo:lang` format, be aware that the repository name is visible to everyone. All [settings](#customize) are also logged. However, logs can be deleted from the Actions tab (be aware of scheduled runs)
> [!NOTE]
> To disable private repositories, just remove or comment out [the added lines](#user-content-private_enable_lines)
## Customize
Customizing GitHub Language Bar is simple — just add the parameter you want after `?`, as if it was a url: `Langbar?key=param`
- **Include forks: `include_forks = yes/no`[^treating_yes_no] (default: `no`)**
Whether to include [forked](https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project) repositories or not
Example: ``
- **Include collaborative repositories: `include_collaborative = yes/no`[^treating_yes_no] (default/recommended: `no`)**
Whether to include repositories that you don't own but have access to as a **collaborator**. Works only when [private repositories are enabled](#enable-private-repositories)
Example: ``
> $${\color{ProcessBlue}ⓘ\ \text{Note}}$$
> Not a **contributor** — **collaborator**! I can not count contributions yet(
- **Replace language: `replace=language1->language1_new,repo2:language2->language2_new`**
Option to replace the desired language with another language in all repositories or only in a specific repository (comma-separated list)
Example: ``
- **Hide language: `hide=language1,repo2:language2,language3`**
Option to hide the desired language in all repositories or only in a specific repository (comma-separated list)
`
Example of all settings combined:
```
```
> [!NOTE]
> Settings are applied in the order they appear in this list. For example, `hide` is always applied after `replace`
## Logging
If you want to see the number of bytes of each language in each repository (to get an idea of which setting is best to apply) , you can use the `log` parameter.
[Be mindful of your privacy!](#privacy_log_warning)
```DIFF
steps:
- name: Create Language Bar
uses: npanuhin/GitHub-Language-Bar@master
+ with:
+ log: true
```
After the GitHub Action completes, the log will be at `{your_repo_url}/blob/language-bar/log.txt`.
For example: https://github.com/npanuhin/npanuhin/blob/language-bar/log.txt
## Pro tips
1. As in URLs, individual settings can be used multiple times. For example:
``
is equal to [the previous `hide` example](#hide_setting_example)
2. If you want to add a bar to a file other than `/README.md`, you can specify its path in the `readme_path` parameter (without leading slash):
```DIFF
steps:
- name: Create Language Bar
uses: npanuhin/GitHub-Language-Bar@master
+ with:
+ readme_path: 'path/to/my/awesome/README.md'
```
## Contributing
For technical details and TODO list see [contribution guide](.github/CONTRIBUTING.md)
[^anywhere_in_readme]: Actually, it should be on a separate line
[^treating_yes_no]: `YeS`, `1`, `true`, `on`, etc. are treated as `yes`, otherwise as `no`