Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yi-xu-0100/traffic2badge
Traffic to badge action usage template. Use repositories Insights/traffic data to generate badges that include views and clones.
https://github.com/yi-xu-0100/traffic2badge
action badge generator insight javascript-action traffic traffic-to-badge
Last synced: 3 months ago
JSON representation
Traffic to badge action usage template. Use repositories Insights/traffic data to generate badges that include views and clones.
- Host: GitHub
- URL: https://github.com/yi-xu-0100/traffic2badge
- Owner: yi-Xu-0100
- License: mit
- Created: 2020-10-21T00:14:32.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T00:36:04.000Z (3 months ago)
- Last Synced: 2024-10-30T02:51:41.902Z (3 months ago)
- Topics: action, badge, generator, insight, javascript-action, traffic, traffic-to-badge
- Homepage: https://github.yixuju.cn/traffic2badge
- Size: 32.4 MB
- Stars: 14
- Watchers: 4
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚡️ traffic2badge
[![sync2gitee(list)]()](https://github.com/yi-Xu-0100/hub-mirror)
[](https://github.com/yi-Xu-0100/traffic2badge/actions?query=workflow%3Atraffic2badge)
[](./)
[](./LICENSE)
[](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic)
[](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic)
[](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic)
[](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic)
[](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic#-total-traffic-data-badge)
[](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic#-total-traffic-data-badge)
[](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic#-total-traffic-data-badge)
[](https://github.com/yi-Xu-0100/traffic2badge/tree/traffic#-total-traffic-data-badge)
Usage template repository of [traffic-to-badge GitHub Action](https://github.com/marketplace/actions/traffic-to-badge), you can use repositories `Insights/traffic` data to generate badges that include views and clones.
[**English**](./README.md) | [简体中文](./README_CN.md)
## 🚀 Configuration
There are **only one input must be set up** and four inputs can be set to default without config. The default setting only supports running repository, and if repositories support is required, please refer to [Usage for `static_list`](#-usage-for-static_list).
| input | description | required | default |
| :---------------------: | :--------------------------------------------------------------------------: | :------: | :---------------: |
| my_token | Personal access token to obtain the secret repository traffic data | ✔ | |
| static_list | List of repositories which want to be got | ✖ | github.repository |
| traffic_branch | Branch used to back up traffic data | ✖ | traffic |
| views_color | Color value for the views badge background | ✖ | brightgreen |
| clones_color | Color value for the clones badge background | ✖ | brightgreen |
| views_week_color | Color value for the views in past week badge background | ✖ | brightgreen |
| clones_week_color | Color value for the clones in past week badge background | ✖ | brightgreen |
| total_views_color | Color value for the views badge background of all repositories | ✖ | brightgreen |
| total_clones_color | Color value for the clones badge background of all repositories | ✖ | brightgreen |
| total_views_week_color | Color value for the views in past week badge background of all repositories | ✖ | brightgreen |
| total_clones_week_color | Color value for the clones in past week badge background of all repositories | ✖ | brightgreen |
| logo | Logo or simple-icon to the left of the label | ✖ | github |
| year | Year for license startup | ✖ | |
### 📝 Usage for `static_list`
**[`repo-list-generator`](https://github.com/marketplace/actions/repo-list-generator): Default output `repoList` do not include `private` and `fork` repositories.**
```yaml
name: traffic2badge
on:
push:
schedule:
- cron: '1 0 * * *'
jobs:
run:
name: Make GitHub Traffic to Badge
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/[email protected]
- name: Get Repo List
id: repo
uses: yi-Xu-0100/[email protected]
- name: Get Commit Message
id: message
uses: actions/[email protected]
env:
FULL_COMMIT_MESSAGE: '${{ github.event.head_commit.message }}'
with:
result-encoding: string
script: |
var message = `${process.env.FULL_COMMIT_MESSAGE}`;
core.info(message);
if (message != '') return message;
var time = new Date(Date.now()).toISOString();
core.info(time);
return `Get traffic data at ${time}`;
- name: Set traffic
id: traffic
uses: yi-Xu-0100/[email protected]
with:
my_token: ${{ secrets.TRAFFIC_TOKEN }}
static_list: '${{ steps.repo.outputs.repoList }}'
#(default) traffic_branch: traffic
#(default) views_color: brightgreen
#(default) clones_color: brightgreen
#(default) views_week_color: brightgreen
#(default) clones_week_color: brightgreen
#(default) total_views_color: brightgreen
#(default) total_clones_color: brightgreen
#(default) total_views_week_color: brightgreen
#(default) total_clones_week_color: brightgreen
#(default) logo: github
year: 2021
- name: Deploy
uses: peaceiris/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: ${{ steps.traffic.outputs.traffic_branch }}
publish_dir: ${{ steps.traffic.outputs.traffic_path }}
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
full_commit_message: ${{ steps.message.outputs.result }}
- name: Show traffic data
run: |
cd ${{ steps.traffic.outputs.traffic_path }}
ls -a
```
**Explanation:**
1. The [`repo-list-generator`](https://github.com/marketplace/actions/repo-list-generator) generates `repoList` for `static_list` usage.
2. The [`github-script`](https://github.com/marketplace/actions/github-script) generates message for commit.
3. The [`actions-gh-pages`](https://github.com/marketplace/actions/github-pages-action) publish traffic data to `traffic_branch`. The options follow this [`guide`](https://github.com/marketplace/actions/github-pages-action#table-of-contents).
4. The `TRAFFIC_TOKEN` needs to be generated, the guild in [Generate `my_token`](https://github.com/yi-Xu-0100/traffic-to-badge#-generate-my_token) .
5. The `GITHUB_TOKEN` does not need to be generated，only reference it in your workflow file，and the guide in [Using the `GITHUB_TOKEN` in a workflow](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow) .
## 🎉 Thanks
- [sangonzal/repository-traffic-action](https://github.com/sangonzal/repository-traffic-action)
- [yi-Xu-0100/traffic-to-badge](https://github.com/yi-Xu-0100/traffic-to-badge)
- [actions/checkout](https://github.com/actions/checkout)
- [actions/github-script](https://github.com/actions/github-script)
- [yi-Xu-0100/repo-list-generator](https://github.com/yi-Xu-0100/repo-list-generator)
- [peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages)
## 📄 LICENSE
- [MIT](./LICENSE)