Skip to content

Commit

Permalink
Merge pull request #56 from jgehrcke/140
Browse files Browse the repository at this point in the history
update readme and changelog towards 1.4.0 release
  • Loading branch information
jgehrcke committed May 18, 2022
2 parents 026fbb8 + 3ac42b6 commit d07bc52
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 15 deletions.
16 changes: 11 additions & 5 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
# Changelog

## 1.4.0
## 1.4.0 (2022-05-18)

Bug fixes:

* Do not fail Action when the number of data points to be plotted in a single graph grows beyond 5000 (also see [#52](https://github.com/jgehrcke/github-repo-stats/issues/52)).
* Do not fail Action when no forks exist (also see [#49](https://github.com/jgehrcke/github-repo-stats/issues/49)).

Data handling:

* Make the top-N plots for referrers and pages less busy: show the top 7 instead of top 10 and downsample to one data point per five days if the total of samples would otherwise grow beyond 3000.
* Make the top-N plots for referrers and pages less busy: show the top 7 instead of top 10 and downsample to one data point per five days if the total number of samples would otherwise grow beyond 3000.

Bug fixes:
Misc:

* Do not fail Action when the number of data point to be plotted in a single graph grows beyond 5000 (also see [#52](https://github.com/jgehrcke/github-repo-stats/issues/52)).
* Do not fail Action when no forks exist (also see [#49](https://github.com/jgehrcke/github-repo-stats/issues/49)).
* Log output: improved debuggability.
* Conservative dependency update; new base image.

Testing: better coverage of `entrypoint.sh` logic in CI, better debuggability of `bats`-based CLI tests.

## 1.3.0 (2021-12-03)

Expand Down
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,22 @@

A GitHub Action ([in Marketplace](https://github.com/marketplace/actions/github-repo-stats)) built to overcome the [14-day limitation](https://github.com/isaacs/github/issues/399) of GitHub's built-in traffic statistics.

Data that you don't persist today will be gone in two weeks from now.

High-level method description:

* This GitHub Action runs once per day. Each run yields a snapshot of repository traffic statistics (influenced by the past 14 days). Snapshots are persisted via git.
* Each run performs data analysis on all individual snapshots and generates a report from the aggregate — covering an *arbitrarily* long time frame.

Start collecting data with this action **today!**

Data that you don't collect today will be gone in two weeks from now.

## Demo

* Report:
* [HTML report](https://jgehrcke.github.io/ghrs-test/jgehrcke/github-repo-stats/latest-report/report.html)
* [PDF report](https://jgehrcke.github.io/ghrs-test/jgehrcke/github-repo-stats/latest-report/report.pdf)
* Action setup (how the above's report is generated):
* [Workflow file](https://github.com/jgehrcke/ghrs-test/blob/github-repo-stats/.github/workflows/github-repo-stats.yml)
* [Data branch](https://github.com/jgehrcke/ghrs-test/tree/github-repo-stats/jgehrcke/github-repo-stats)
**Demo 1**:
* [HTML report](https://jgehrcke.github.io/ghrs-test/jgehrcke/github-repo-stats/latest-report/report.html), [PDF report](https://jgehrcke.github.io/ghrs-test/jgehrcke/github-repo-stats/latest-report/report.pdf)
* [Workflow file](https://github.com/jgehrcke/ghrs-test/blob/github-repo-stats/.github/workflows/github-repo-stats.yml), [data branch](https://github.com/jgehrcke/ghrs-test/tree/github-repo-stats/jgehrcke/github-repo-stats)

**Demo 2**:
* [HTML report](https://jgehrcke.github.io/ghrs-test/jgehrcke/covid-19-germany-gae/latest-report/report.html), [PDF report](https://jgehrcke.github.io/ghrs-test/jgehrcke/covid-19-germany-gae/latest-report/report.pdf)
* [Workflow file](https://github.com/jgehrcke/ghrs-test/blob/covid-19-germany-gae/.github/workflows/github-repo-stats.yml), [data branch](https://github.com/jgehrcke/ghrs-test/tree/covid-19-germany-gae/jgehrcke/github-repo-stats)

## Highlights

Expand Down

0 comments on commit d07bc52

Please sign in to comment.