{"header":{"message":"Add GithubRefs plugin","description":"This plugin is a counterpart to GithubPulls plugin. Instead of fetching pull\nrequests, it will fetch all references (branches and tags) that start with a\nparticular prefix.\n\nThe plugin is a copy of GithubPulls plugin with appropriate changes to call the\nright API and parse the config matching the need.","timestamp":"2020-04-21T12:47:19Z","authors":[{"email":"nikola@knezevic.ch","name":"Nikola Knezevic"}]},"hash":"KIRRGSUC3CDJVYLEQ5OS2RTFIJ6OTN37YLBIWQCMCNZWYZISMCUQC","authors":[],"deps":{"hashes":[["KIRRGSUC3CDJVYLEQ5OS2RTFIJ6OTN37YLBIWQCMCNZWYZISMCUQC","Add GithubRefs plugin"],["AA",null],["5EQYVRWECBDJORGI5DRIOUEJXSXMRCQNT2562BM4Z4U52LT7JUHAC","Add a plugin mechanism"]],"deps":["5EQYVRWECBDJORGI5DRIOUEJXSXMRCQNT2562BM4Z4U52LT7JUHAC"],"known":[]},"hunks":[{"FileAdd":{"meta":{"basename":"GithubRefs.pm","metadata":0},"context":[{"change":2,"pos":1}],"contents":[{"Add":"package Hydra::Plugin::GithubRefs;"},{"Add":""},{"Add":"use strict;"},{"Add":"use parent 'Hydra::Plugin';"},{"Add":"use HTTP::Request;"},{"Add":"use LWP::UserAgent;"},{"Add":"use JSON;"},{"Add":"use Hydra::Helper::CatalystUtils;"},{"Add":"use File::Temp;"},{"Add":"use POSIX qw(strftime);"},{"Add":""},{"Add":"=head1 NAME"},{"Add":""},{"Add":"GithubRefs - Hydra plugin for retrieving the list of references (branches or"},{"Add":"tags) from GitHub following a certain naming scheme"},{"Add":""},{"Add":"=head1 DESCRIPTION"},{"Add":""},{"Add":"This plugin reads the list of branches or tags using GitHub's REST API. The name"},{"Add":"of the reference must follow a particular prefix. This list is stored in the"},{"Add":"nix-store and used as an input to declarative jobsets."},{"Add":""},{"Add":"=head1 CONFIGURATION"},{"Add":""},{"Add":"The plugin doesn't require any dedicated configuration block, but it has to"},{"Add":"consult C entry for obtaining the API token. In addition,"},{"Add":"if C entry is present in the configuration, it will be used"},{"Add":"instead of the default C. This entry is useful when"},{"Add":"dealing with GitHub Enterprise."},{"Add":""},{"Add":"The declarative project C file must contains an input such as"},{"Add":""},{"Add":" \"pulls\": {"},{"Add":" \"type\": \"github_refs\","},{"Add":" \"value\": \"[owner] [repo] heads|tags - [prefix]\","},{"Add":" \"emailresponsible\": false"},{"Add":" }"},{"Add":""},{"Add":"In the above snippet, C<[owner]> is the repository owner and C<[repo]> is the"},{"Add":"repository name. Also note a literal C<->, which is placed there for the future"},{"Add":"use."},{"Add":""},{"Add":"C denotes that one of these two is allowed, that is, the third"},{"Add":"position should hold either the C or the C keyword. In case of the former, the plugin"},{"Add":"will fetch all branches, while in case of the latter, it will fetch the tags."},{"Add":""},{"Add":"C denotes the prefix the reference name must start with, in order to be"},{"Add":"included."},{"Add":""},{"Add":"For example, C<\"value\": \"nixos hydra heads - release/\"> refers to"},{"Add":"L repository, and will fetch all branches that"},{"Add":"begin with C."},{"Add":""},{"Add":"=head1 USE"},{"Add":""},{"Add":"The result is stored in the nix-store as a JSON I, where the key is the"},{"Add":"name of the reference, while the value is the complete GitHub response. Thus,"},{"Add":"any of the values listed in"},{"Add":"L can be"},{"Add":"used to build the git input value in C."},{"Add":""},{"Add":"=cut"},{"Add":""},{"Add":"sub supportedInputTypes {"},{"Add":" my ($self, $inputTypes) = @_;"},{"Add":" $inputTypes->{'github_refs'} = 'Open GitHub Refs';"},{"Add":"}"},{"Add":""},{"Add":"sub _iterate {"},{"Add":" my ($url, $auth, $refs, $ua) = @_;"},{"Add":" my $req = HTTP::Request->new('GET', $url);"},{"Add":" $req->header('Accept' => 'application/vnd.github.v3+json');"},{"Add":" $req->header('Authorization' => $auth) if defined $auth;"},{"Add":" my $res = $ua->request($req);"},{"Add":" my $content = $res->decoded_content;"},{"Add":" die \"Error pulling from the github refs API: $content\\n\""},{"Add":" unless $res->is_success;"},{"Add":" my $refs_list = decode_json $content;"},{"Add":" # TODO Stream out the json instead"},{"Add":" foreach my $ref (@$refs_list) {"},{"Add":" my $ref_name = $ref->{ref};"},{"Add":" $ref_name =~ s,^refs/(?:heads|tags)/,,o;"},{"Add":" $refs->{$ref_name} = $ref;"},{"Add":" }"},{"Add":" # TODO Make Link header parsing more robust!!!"},{"Add":" my @links = split ',', $res->header(\"Link\");"},{"Add":" my $next = \"\";"},{"Add":" foreach my $link (@links) {"},{"Add":" my ($url, $rel) = split \";\", $link;"},{"Add":" if (trim($rel) eq 'rel=\"next\"') {"},{"Add":" $next = substr trim($url), 1, -1;"},{"Add":" last;"},{"Add":" }"},{"Add":" }"},{"Add":" _iterate($next, $auth, $refs, $ua) unless $next eq \"\";"},{"Add":"}"},{"Add":""},{"Add":"sub fetchInput {"},{"Add":" my ($self, $type, $name, $value, $project, $jobset) = @_;"},{"Add":" return undef if $type ne \"github_refs\";"},{"Add":""},{"Add":" my ($owner, $repo, $type, $fut, $prefix) = split ' ', $value;"},{"Add":" die \"type field is neither 'heads' nor 'tags', but '$type'\""},{"Add":" unless $type eq 'heads' or $type eq 'tags';"},{"Add":""},{"Add":" my $auth = $self->{config}->{github_authorization}->{$owner};"},{"Add":" my $githubEndpoint = $self->{config}->{github_endpoint} // \"https://api.github.com\";"},{"Add":" my %refs;"},{"Add":" my $ua = LWP::UserAgent->new();"},{"Add":" _iterate(\"$githubEndpoint/repos/$owner/$repo/git/matching-refs/$type/$prefix?per_page=100\", $auth, \\%refs, $ua);"},{"Add":" my $tempdir = File::Temp->newdir(\"github-refs\" . \"XXXXX\", TMPDIR => 1);"},{"Add":" my $filename = \"$tempdir/github-refs.json\";"},{"Add":" open(my $fh, \">\", $filename) or die \"Cannot open $filename for writing: $!\";"},{"Add":" print $fh encode_json \\%refs;"},{"Add":" close $fh;"},{"Add":" system(\"jq -S . < $filename > $tempdir/github-refs-sorted.json\");"},{"Add":" my $storePath = trim(qx{nix-store --add \"$tempdir/github-refs-sorted.json\"}"},{"Add":" or die \"cannot copy path $filename to the Nix store.\\n\");"},{"Add":" chomp $storePath;"},{"Add":" my $timestamp = time;"},{"Add":" return { storePath => $storePath, revision => strftime \"%Y%m%d%H%M%S\", gmtime($timestamp) };"},{"Add":"}"},{"Add":""},{"Add":"1;"}]}}],"owner":"grahamc","repo":"hydra2","token":"QFmgdCf9VGGCZxg7DbMj29z++euJRcPZLJAnAa1qfMw=","login":null}

…

Dependencies

Change contents