Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/GuillaumeFalourd/repositories-reports

You can fork this project to get weekly insights reports for your personal repositories ⏱ 📋 :octocat:
https://github.com/GuillaumeFalourd/repositories-reports

automation csv github-actions insights open-source reports ritchie-cli useful

Last synced: 26 days ago
JSON representation

You can fork this project to get weekly insights reports for your personal repositories ⏱ 📋 :octocat:

Awesome Lists containing this project

README

        

# repositories-reports

[![1 - Reports Generator](https://github.com/GuillaumeFalourd/repositories-reports/actions/workflows/1-reports-generator.yml/badge.svg)](https://github.com/GuillaumeFalourd/repositories-reports/actions/workflows/1-reports-generator.yml)

[![2 - Alternative Reports Generator](https://github.com/GuillaumeFalourd/repositories-reports/actions/workflows/2-alternative-reports-generator.yml/badge.svg)](https://github.com/GuillaumeFalourd/repositories-reports/actions/workflows/2-alternative-reports-generator.yml)

![Title](/docs/repository-title.png)

Repository with weekly insights reports for the Github user personal repositories

This repository uses [Github Actions](https://github.com/features/actions) and [Ritchie CLI](https://ritchiecli.io).

## Sample of generated reports

This repository will gather on the `/reports` directory weekly reports with the following datas:

### 🕵️ Insights from last 14 days

- Views 👀
- Uniques 👁
- Clones 📥

### 🕵️ Insights from the moment the automation is executed

- Contributores 👥
- Forks 🔀
- Stars ⭐️
- Watchers 🎥

Reports will look like this one:

![Sample](/docs/report-sample.png)

## ♻️ Want to get your repo-reports?

- **Create a new repository** (you can clone or fork this one)

```bash
git clone https://github.com/GuillaumeFalourd/repositories-reports.git
```

- Add 2 secrets on the new repository ([here is a reference](https://docs.github.com/en/actions/reference/encrypted-secrets)):
- a secret `ACCESS_TOKEN` (you can create one [here](https://github.com/settings/tokens))
- a secret `USERNAME_CREDENTIAL` with your Github User account (`GuillaumeFalourd` in my case)

*Note: [You can also use Ritchie CLI to add new secrets to your repository](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/add/secret)*