Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andry81-devops/github-accum-stats

Tutorial to setup accumulation of various GitHub repository/account statistic. • :page_with_curl: https://github.com/andry81-stats/github-accum-stats--gh-stats :page_with_curl:
https://github.com/andry81-devops/github-accum-stats

actions devops github github-action github-statistics statistics tutorial workflow

Last synced: 17 days ago
JSON representation

Tutorial to setup accumulation of various GitHub repository/account statistic. • :page_with_curl: https://github.com/andry81-stats/github-accum-stats--gh-stats :page_with_curl:

Awesome Lists containing this project

README 

        


  

    GitHub views|any|total

    GitHub views|any|14d

• 

    GitHub views|unique per day|total

    GitHub views|unique per day|14d






  

    GitHub clones|any|total

    GitHub clones|any|14d

• 

    GitHub clones|unique per day|total

    GitHub clones|unique per day|14d






  donate




---



# Tutorial to setup accumulation of various GitHub repository/account statistic



> This implementation is based on that: https://github.com/andry81-devops/github-clone-count-badge



> **Warning** This tutorial is contain content related to the GitHub itself. All other description has moved into other tutorials.

>



All tutorials: https://github.com/andry81/index#tutorials



## Features:



1. Implementation can accumulate GitHub traffic clones or/and views, GitHub account rate limits of an authenticated user.



2. Workflow has used a bash script to accumulate statistic:



   * GitHub traffic clones/views: [accum-stats.sh](https://github.com/andry81-devops/gh-workflow/tree/HEAD/bash/github/accum-stats.sh)



   * GitHub account rate limits: [accum-rate-limits.sh](https://github.com/andry81-devops/gh-workflow/tree/HEAD/bash/github/accum-rate-limits.sh)



3. Basically most of the scripts does accumulate the response. For example, the clones accumulator script does accumulate statistic both into a single file: `traffic/clones/latest-accum.json`,

   and into a set of files grouped by year and allocated per day: `traffic/clones/by_year/YYYY/YYYY-MM-DD.json`.



4. A repository based accumulator script has a repository to track and a repository to store traffic statistic and they may be different. If they is different, then you can directly point the statistic as a standalone commits list: `https://github.com/{{REPO_OWNER}}/{{REPO}}--gh-stats/commits/master/traffic/clones`.



5. All scripts does use GitHub composite action to reuse workflow code base: https://docs.github.com/en/actions/creating-actions/creating-a-composite-action



> **Warning** Not all features of a generic GitHub action is supported: [Known Issues](#known-issues)



## Repositories:



You need setup 3-4 repositories.



1. Repository which statistic you want to track: `myrepo`.


   > **Note** This repository is only required for repository based statistic scripts.



2. Repository, where statistic will be saved: `myrepo--gh-stats`.


   > **Note** You still can use a single repository to request and to store, but it is not convenient and will distort the clone statistic (at least until the GitHub action user who is used to checkout the statistic output repository won't be involved into clones counter change), so is not recommended.



3. Repository, where to store github workflow support scripts: `gh-workflow`.


   You can fork or use it from here: https://github.com/andry81-devops/gh-workflow



4. Repository, where to store github composite action:



   * GitHub composite action to request and accumulate a repository clones/views statistic:


     https://github.com/andry81-devops/gh-action--accum-gh-stats



   * GitHub composite action to request and accumulate an account rate limits:


     https://github.com/andry81-devops/gh-action--accum-gh-rate-limits



   All action scripts:


   https://github.com/andry81/index#action-scripts



> **Note** See REUSE section for details if you have multiple repositories and want to store all GitHub workflow scripts (`.github/workflows/*.yml`) in a single repository.



> **Note** You need to attach a personal access token (PAT) into a repository used to run a GitHub action script (`.github/workflows/*.yml`) to read content from another repository and obtain the read permission from that repository: `repo`->`public_repo`.



> **Note** You need to attach a personal access token (PAT) into a repository used to run a GitHub action script (`.github/workflows/*.yml`) to write content into another repository and obtain the push permission into that repository: `repo`.



> **Note** You need to attach a personal access token (PAT) into a repository used to run a GitHub action script (`.github/workflows/*.yml`) to read statistic of another repository and obtain the push permission into that repository: `repo`.



> **Note** A separate personal access token (PAT) does not require to be attached into a repository used to run a GitHub action script for another repository as long as that another repository is owned by the same owner as a repository which runs a GitHub action script.



* `myrepo` -> needs read/write access permissions to read repository statistic as not public repository metadata (not files)

* `myrepo--gh-stats` -> needs read/write access permissions to read/write repository files



To generate PAT: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token



To attach PAT: https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository



> **Warning** Beginning from the `gh-workflow` `1.3.0` as a dependency to all action scripts the checkout action script https://github.com/actions/checkout can be replaced by a wrapper script https://github.com/andry81-devops/gh-action--git-checkout which does support checkout from an empty repository and you can leave an output repository empty before the first checkout.

> Now the initial output repository state is not required as input. The information about initial output repository state is removed from here.



The `myrepo` repository should contain 1 file per statistic entity:



* [.github/workflows/accum-gh-clone-stats.yml example](https://github.com/andry81-devops/gh-action--accum-gh-stats#accum-gh-clone-stats-yml)



* [.github/workflows/accum-gh-view-stats.yml example](https://github.com/andry81-devops/gh-action--accum-gh-stats#accum-gh-view-stats-yml)



* [.github/workflows/accum-gh-rate-limits.yml example](https://github.com/andry81-devops/gh-action--accum-gh-rate-limits#accum-gh-rate-limits-yml)



> **Warning** You must replace all placeholder into respective values:



* `{{REPO_OWNER}}` -> repository owner

* `{{REPO}}` -> `myrepo`



After the github workflow yaml file is commited and pushed, you can run the action from the `Actions` tab in the `myrepo` repository.



After that you can add badges to reference a repository statistic:



```xml



  

    GitHub views|any|total

    GitHub views|any|14d

• 

    GitHub views|unique per day|total

    GitHub views|unique per day|14d






  

    GitHub clones|any|total

    GitHub clones|any|14d

• 

    GitHub clones|unique per day|total

    GitHub clones|unique per day|14d



```



> **Note** There is https://github.com/andry81-devops/gh-action--accum-content action script which can periodically download all the dynamic badges and other files into a content cache repository.



You can add links pointing a content cache repository instead, to leave the `README.md` a bit simplier:



```xml



  

    GitHub views|any|total

    GitHub views|any|14d

• 

    GitHub views|unique per day|total

    GitHub views|unique per day|14d






  

    GitHub clones|any|total

    GitHub clones|any|14d

• 

    GitHub clones|unique per day|total

    GitHub clones|unique per day|14d



```



##Features of a standalone content cache repository:



https://github.com/andry81-devops/accum-content#features-of-a-standalone-content-cache-repository



## REUSE



> **Warning** The GitHub does disable all workflow scripts in case of repository main branch inactivity for a period of time: [Known Issues](#known-issues)



You can reuse all workflow scripts from a single repository to ease the maintain and scripts edit.



For example, if you have 3 repositories `myrepo1`, `myrepo2`, `myrepo3` and the repository owner is `user`, then you can put all workflow scripts into a single repository `github.com/user/user/.github/workflows` in this way:



* `myrepo1.accum-gh-clone-stats.yml`

* `myrepo1.accum-gh-view-stats.yml`

* `myrepo2.accum-gh-clone-stats.yml`

* `myrepo2.accum-gh-view-stats.yml`

* `myrepo3.accum-gh-clone-stats.yml`

* `myrepo3.accum-gh-view-stats.yml`



And use slightly different naming:



```yml

name: "myrepo1: GitHub clones counter for 14 days at every 8 hours and clones accumulator"

```



```yml

name: "myrepo1: GitHub views counter for 14 days at every 8 hours and views accumulator"

```



> **Note** If you have multiple repositories to store the statistic, then you can create a github organization account like `-stats` and move all statistic repositories into organization's account.

> It will leave the repositories page of the original account untouched on each commit into an organization account repository.



## Known Issues



https://github.com/andry81-devops/gh-known-issues#known-issues



## Last known issues updates



https://github.com/andry81-devops/gh-known-issues#last-known-issues-updates