nextcloud / github_helper

:construction_worker: little helper scripts to handle GitHub milestones and labels

Github helper scripts

This is a little collection of useful helper scripts.

credentials.json

All the scripts inside this repo need a credentials.json in their home folder (e.g. brancher/ ). The content should be a JSON object with username (your github account name) and apikey (generate one in Settings > Developer settings > Personal access tokens), e.g.:

{
  "username": "nickvergessen",
  "apikey": "1234567890abcdef1234567890abcdef12345678"
}

Changelog generator

• provide the credentials by placing a copy of credentials.dist.json as credentials.json in the root of this folder
• go into changelog/
• install composer dependencies: composer install

Generate changelog command

Syntax:

php index.php generate:changelog $repoName $base $head --format=$format

The format setting has the following options:

• Github (default)
• forum (--format=forum - Markdown with absolute links)
• changelog page on our website (--format=html - HTML list with absolute links)

E.g. to generate the changelog for the upcoming 13.0.1 server release. This script automatically derives the milestone from the first argument "v13.0.0" will mean that the milestone "13.0.1" will be checked for pending pull requests:

php index.php generate:changelog server v13.0.0 stable13

E.g. generate the changelog for the upcoming 3.3.0 Android release:

php index.php generate:changelog android stable-3.3.0 stable-3.3.x

E.g. to generate the pending PRs for a very first beta of a major release run (mind, the vxx.0.0beta0 tag is expected NOT to exist)):

php index.php generate:changelog server v42.0.0beta0 master

github_helper's Issues

changelog script throws error: "Could not find base or head reference."

Running this:
$ php index.php generate:changelog server v15.0.5 v15.0.6 --format=html
I get:

repo: server
base: v15.0.5
head: v15.0.6
Checking milestone 15.0.6 for pending PRs ...
 Fetching PR titles for survey_client ...
 45/54 [=======================>----]  83%
 Remaining: 6 secsCould not find base or head reference.

Use github org labels

Github now provide default labels
https://github.com/organizations/nextcloud/settings/labels

Jan & I set them up, we should probable use those ones now instead of having two different settings that few people knows about :)
Unfortunately, the current org settings is only used for new repos, but there are tools available already https://github.com/dwyl/labels, https://github.com/Financial-Times/github-label-sync,

cc @rullzer @nickvergessen @MorrisJobke @jancborchardt

Changelog generator provides wrong links and headings

For example php index.php generate:changelog -f html server v23.0.2 v23.0.3 outputs header and links to 23.0.4, where it should be 23.0.3.

deal with the rate limiting like matomo does

So Matomo works around the rate limits that block us from generating a full change log between major releases, from what I get. Perhaps we can adopt this.
https://github.com/matomo-org/github-changelog-generator

changelog script: do not use compare

https://developer.github.com/v3/repos/commits/#compare-two-commits

This returns max 250 commits. Which is not enough.

changelog broken for 15.0.14? "Could not find base or head reference."

$ php index.php generate:changelog server v15.0.13 stable15 --format=html
repo: server
base: v15.0.13
head: stable15
Checking milestone 15.0.14 for pending PRs ...
Fetching PR titles for activity ...
9/45 [=====>----------------------] 20%
Remaining: 20 secsCould not find base or head reference.

Ref - #16 - no clue if that is related. @rullzer I know you're busy but this blocks me for updating the site :(

EDIT: same for 16.0.6 and 17.0.1
Does work for 15.0.12 and 17.0.0! So something is broken wrt the latest releases.