Traffic to Badge
ActionsTags
(2)/badge.svg){kind=icon}
The GitHub action that using repositories Insights/traffic data to generate badges that include views and clones.
Notion: It will also backup your secret traffic data into traffic branch .
- ⚡️ Traffic to Badge GitHub Action
- 🎨 Table of Contents
- 🚀 Configuration
- 📝 Example that using repo-list-generator to generate repository list
- 📝 Use dependabot to keep action up-to-date
- 🙈 Generate
my_token - 🔊 CHANGELOG
- 📄 LICENSE
- 🎉 Thanks
input:
my_token:
description: 'Set up a personal access token to obtain the secret repository traffic data.'
required: true
static_list:
description: 'Set up a list of repositories to get.'
required: true
traffic_branch:
description: 'If empty traffic data will be backed up to the branch named traffic.'
required: false
default: 'traffic'
views_color:
description: 'Set a hex or named color value for the views badge background.'
required: false
default: 'brightgreen'
clones_color:
description: 'Set a hex or named color value for the clones badge background.'
required: false
default: 'brightgreen'
logo:
description: 'Insert a named logo or simple-icon to the left of the label.'
required: false
default: 'github'This example use yi-Xu-0100/repo-list-generator to generate static_list and show the result of traffic branch.
name: traffic2badge
on:
schedule:
- cron: '1 18 * * *' # UTC 18:01
jobs:
run:
name: Make GitHub Traffic to Badge
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v2.3.3
- name: Get Repo List
id: repo
uses: yi-Xu-0100/repo-list-generator@v0.3.0
- name: Get Commit Message
id: message
uses: actions/github-script@v3.0.0
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: Get Traffic
id: traffic
uses: yi-Xu-0100/traffic-to-badge@v1.1.2
with:
my_token: ${{ secrets.TRAFFIC_TOKEN }}
static_list: '${{ steps.repo.outputs.repo }}'
traffic_branch: traffic
views_color: brightgreen
clones_color: brightgreen
logo: github
- name: Show Traffic Data
run: |
echo ${{ steps.traffic.outputs.traffic_branch }}
echo ${{ steps.traffic.outputs.traffic_path }}
cd ${{ steps.traffic.outputs.traffic_path }}
ls -aThis file is build in ./github/dependabot.yml to keep action up-to-date.
version: 2
updates:
# Maintain dependencies for GitHub Actions
- package-ecosystem: 'github-actions'
directory: '/'
schedule:
interval: 'daily'This part is obtained from sangonzal/repository-traffic-action.
You'll first need to create a personal access token (PAT) which make the action having the access to the GitHub API.
You can generate a PAT by going to Settings(GitHub) -> Developer Settings -> Personal Access Tokens -> Generate new token, and will need to grant repo permission. For more information, see the GitHub documentation.
After you generated the PAT, go to Settings(repository) -> Secrets -> New secret, name the secret TRAFFIC_TOKEN and copy the PAT into the box.
Traffic to Badge is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
About
Tags
(2)Traffic to Badge is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.