This is a clone count badge shows 14 days clone statistics of a GitHub repository.
- Use a GitHub action to get repository clones using
https://api.github.com/repos/{username}/{repo}/traffic/clonesthis api. A json file named clone will be added to the repository's default branch. - Then shields.io dynamic badge will parse this clone.json file to show the clone count.
- GitHub actions will run every 8 hours.
- Create a new workflow from the
Actionstab of your repository and paste the following.
name: GitHub Clone Count for 14 days at every 8 hours
# Controls when the action will run.
on:
schedule:
- cron: "0 */8 * * *"
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v2
- name: Parse clone count using REST API
run: |
curl --user "${{ github.actor }}:${{ secrets.SECRET_TOKEN }}" \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/repos/${{ github.repository }}/traffic/clones \
> clone.json
- name: Add to git repo
run: |
git add .
git config --global user.name "GitHub Action"
git config --global user.email "[email protected]"
git commit -m "Automated clone.json update"
- name: Push
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
- To use this, you will need a personal access token. See this https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token to get one.
- Next, add action secrets to this repository like https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository this. Remember
SECRET_TOKENmust be the secret name. And the value will be the personal access token you just generated.
Replace <url> with clone.json url.
Markdown
[](https://github.com/MShawon/github-clone-count-badge)HTML
<a href="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/MShawon/github-clone-count-badge"><img alt="GitHub Clones" src="https://img.shields.io/badge/dynamic/json?color=success&label=Clone&query=count&url=<url>?raw=True&logo=github"></a>