[DOCS] Add release notes script that merges two repos
Original commit: elastic/x-pack-elasticsearch@935c7312f1
This commit is contained in:
lcawley
parent
ea94ef3aa9
commit
357a79f44c
|
|
@ -0,0 +1,270 @@
|
|||
#!/usr/bin/env perl
|
||||
# Licensed to Elasticsearch under one or more contributor
|
||||
# license agreements. See the NOTICE file distributed with
|
||||
# this work for additional information regarding copyright
|
||||
# ownership. Elasticsearch licenses this file to you under
|
||||
# the Apache License, Version 2.0 (the "License"); you may
|
||||
# not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing,
|
||||
# software distributed under the License is distributed on
|
||||
# an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
# either express or implied. See the License for the specific
|
||||
# language governing permissions and limitations under the License.
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
use HTTP::Tiny 0.070;
|
||||
use IO::Socket::SSL 1.52;
|
||||
use utf8;
|
||||
|
||||
my $Github_Key = load_github_key();
|
||||
my $Base_URL = "https://${Github_Key}api.github.com/repos/";
|
||||
my $User_Repo1 = 'elastic/x-pack-elasticsearch/';
|
||||
my $Issue_URL1 = "http://github.com/${User_Repo1}issues/";
|
||||
my $User_Repo2 = 'elastic/machine-learning-cpp/';
|
||||
my $Issue_URL2 = "http://github.com/${User_Repo2}issues/";
|
||||
|
||||
my @Groups = (
|
||||
"breaking", "breaking-java", "deprecation", "feature",
|
||||
"enhancement", "bug", "regression", "upgrade", "non-issue", "build",
|
||||
"docs", "test"
|
||||
);
|
||||
my %Group_Labels = (
|
||||
breaking => 'Breaking changes',
|
||||
'breaking-java' => 'Breaking Java changes',
|
||||
build => 'Build',
|
||||
deprecation => 'Deprecations',
|
||||
docs => 'Docs',
|
||||
feature => 'New features',
|
||||
enhancement => 'Enhancements',
|
||||
bug => 'Bug fixes',
|
||||
regression => 'Regressions',
|
||||
test => 'Tests',
|
||||
upgrade => 'Upgrades',
|
||||
"non-issue" => 'Non-issue',
|
||||
other => 'NOT CLASSIFIED',
|
||||
);
|
||||
|
||||
use JSON();
|
||||
use Encode qw(encode_utf8);
|
||||
|
||||
my $json = JSON->new->utf8(1);
|
||||
|
||||
my %All_Labels1 = fetch_labels($User_Repo1);
|
||||
|
||||
my $version = shift @ARGV
|
||||
or dump_labels();
|
||||
|
||||
dump_labels(%All_Labels1, "Unknown version '$version'")
|
||||
unless $All_Labels1{$version};
|
||||
|
||||
my $issues1 = fetch_issues($User_Repo1, $version);
|
||||
|
||||
# Repeat steps for second repo
|
||||
|
||||
my %All_Labels2 = fetch_labels($User_Repo2);
|
||||
|
||||
dump_labels(%All_Labels2, "Unknown version '$version'")
|
||||
unless $All_Labels2{$version};
|
||||
|
||||
my $issues2 = fetch_issues($User_Repo2, $version);
|
||||
|
||||
dump_issues( $User_Repo1, $version, $issues1 );
|
||||
dump_issues( $User_Repo2, $version, $issues2 );
|
||||
|
||||
#===================================
|
||||
sub dump_issues {
|
||||
#===================================
|
||||
my $User_Repo = shift;
|
||||
my $version = shift;
|
||||
my $issues = shift;
|
||||
|
||||
$version =~ s/v//;
|
||||
my ( $day, $month, $year ) = (gmtime)[ 3 .. 5 ];
|
||||
$month++;
|
||||
$year += 1900;
|
||||
|
||||
print <<"ASCIIDOC";
|
||||
|
||||
[[release-notes-$version]]
|
||||
== X-Pack $version Release Notes
|
||||
|
||||
// Pulled from $User_Repo
|
||||
|
||||
ASCIIDOC
|
||||
|
||||
for my $group ( @Groups, 'other' ) {
|
||||
my $group_issues = $issues->{$group} or next;
|
||||
print "[[$group-$version]]\n"
|
||||
. "[float]\n"
|
||||
. "=== $Group_Labels{$group}\n\n";
|
||||
|
||||
for my $header ( sort keys %$group_issues ) {
|
||||
my $header_issues = $group_issues->{$header};
|
||||
print( $header || 'HEADER MISSING', "::\n" );
|
||||
|
||||
for my $issue (@$header_issues) {
|
||||
my $title = $issue->{title};
|
||||
|
||||
if ( $issue->{state} eq 'open' ) {
|
||||
$title .= " [OPEN]";
|
||||
}
|
||||
unless ( $issue->{pull_request} ) {
|
||||
$title .= " [ISSUE]";
|
||||
}
|
||||
my $number = $issue->{number};
|
||||
|
||||
# print encode_utf8("* $title {pull}${number}[#${number}]");
|
||||
print encode_utf8("* $title");
|
||||
print "\n";
|
||||
print encode_utf8("// https://github.com/${User_Repo}pull/${number}[#${number}]");
|
||||
if ( my $related = $issue->{related_issues} ) {
|
||||
my %uniq = map { $_ => 1 } @$related;
|
||||
print keys %uniq > 1
|
||||
? " (issues: "
|
||||
: " (issue: ";
|
||||
# print join ", ", map {"{issue}${_}[#${_}]"}
|
||||
# print join ", ", map {"#${_}"}
|
||||
print join ", ", map {"https://github.com/${User_Repo}issues/${_}[#${_}]"}
|
||||
sort keys %uniq;
|
||||
print ")";
|
||||
}
|
||||
print "\n";
|
||||
}
|
||||
print "\n";
|
||||
}
|
||||
print "\n\n";
|
||||
}
|
||||
}
|
||||
|
||||
#===================================
|
||||
sub fetch_issues {
|
||||
#===================================
|
||||
my $User_Repo = shift;
|
||||
my $version = shift;
|
||||
my @issues;
|
||||
my %seen;
|
||||
for my $state ( 'open', 'closed' ) {
|
||||
my $page = 1;
|
||||
while (1) {
|
||||
my $tranche
|
||||
= fetch( $User_Repo
|
||||
. 'issues?labels='
|
||||
. $version
|
||||
. '&pagesize=100&state='
|
||||
. $state
|
||||
. '&page='
|
||||
. $page )
|
||||
or die "Couldn't fetch issues for version '$version'";
|
||||
push @issues, @$tranche;
|
||||
|
||||
for my $issue (@$tranche) {
|
||||
next unless $issue->{pull_request};
|
||||
for ( $issue->{body} =~ m{(?:#|${User_Repo}issues/)(\d+)}g ) {
|
||||
$seen{$_}++;
|
||||
push @{ $issue->{related_issues} }, $_;
|
||||
}
|
||||
}
|
||||
$page++;
|
||||
last unless @$tranche;
|
||||
}
|
||||
}
|
||||
|
||||
my %group;
|
||||
ISSUE:
|
||||
for my $issue (@issues) {
|
||||
next if $seen{ $issue->{number} } && !$issue->{pull_request};
|
||||
|
||||
# uncomment for including/excluding PRs already issued in other versions
|
||||
# next if grep {$_->{name}=~/^v2/} @{$issue->{labels}};
|
||||
my %labels = map { $_->{name} => 1 } @{ $issue->{labels} };
|
||||
my ($header) = map { substr( $_, 1 ) } grep {/^:/} sort keys %labels;
|
||||
$header ||= 'NOT CLASSIFIED';
|
||||
for (@Groups) {
|
||||
if ( $labels{$_} ) {
|
||||
push @{ $group{$_}{$header} }, $issue;
|
||||
next ISSUE;
|
||||
}
|
||||
}
|
||||
push @{ $group{other}{$header} }, $issue;
|
||||
}
|
||||
|
||||
return \%group;
|
||||
}
|
||||
|
||||
#===================================
|
||||
sub fetch_labels {
|
||||
#===================================
|
||||
my $User_Repo = shift;
|
||||
my %all;
|
||||
my $page = 1;
|
||||
while (1) {
|
||||
my $labels = fetch( $User_Repo . 'labels?page=' . $page++ )
|
||||
or die "Couldn't retrieve version labels";
|
||||
last unless @$labels;
|
||||
for (@$labels) {
|
||||
my $name = $_->{name};
|
||||
next unless $name =~ /^v/;
|
||||
$all{$name} = 1;
|
||||
}
|
||||
}
|
||||
return %all;
|
||||
}
|
||||
|
||||
#===================================
|
||||
sub fetch {
|
||||
#===================================
|
||||
my $url = $Base_URL . shift();
|
||||
# print "$url\n";
|
||||
my $response = HTTP::Tiny->new->get($url);
|
||||
# use Data::Dumper;
|
||||
# print Dumper($response);
|
||||
die "$response->{status} $response->{reason}\n"
|
||||
unless $response->{success};
|
||||
# print $response->{content};
|
||||
return $json->decode( $response->{content} );
|
||||
}
|
||||
|
||||
#===================================
|
||||
sub load_github_key {
|
||||
#===================================
|
||||
|
||||
my ($file) = glob("~/.github_auth");
|
||||
unless ( -e $file ) {
|
||||
warn "File ~/.github_auth doesn't exist - using anonymous API. "
|
||||
. "Generate a personal access token that has repo scope. See https://github.com/elastic/dev/blob/master/shared/development_process.md \n";
|
||||
return '';
|
||||
}
|
||||
open my $fh, $file or die "Couldn't open $file: $!";
|
||||
my ($key) = <$fh> || die "Couldn't read $file: $!";
|
||||
$key =~ s/^\s+//;
|
||||
$key =~ s/\s+$//;
|
||||
die "Invalid GitHub key: $key"
|
||||
unless $key =~ /^[0-9a-f]{40}$/;
|
||||
return "$key:x-oauth-basic@";
|
||||
|
||||
}
|
||||
|
||||
#===================================
|
||||
sub dump_labels {
|
||||
#===================================
|
||||
my %All_Labels = shift;
|
||||
my $error = shift || '';
|
||||
if ($error) {
|
||||
$error = "\nERROR: $error\n";
|
||||
}
|
||||
my $labels = join( "\n - ", '', ( sort keys %All_Labels ) );
|
||||
die <<USAGE
|
||||
$error
|
||||
USAGE: $0 version > outfile
|
||||
|
||||
Known versions:$labels
|
||||
|
||||
USAGE
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue