Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document all_builds (/eval/{eval-id}/builds) endpoint #1300

Merged
merged 2 commits into from
Sep 9, 2023

Conversation

sternenseemann
Copy link
Member

The endpoint is implemented here:

# Return full info about all the builds in this evaluation.
sub all_builds : Chained('evalChain') PathPart('builds') Args(0) {
my ($self, $c) = @_;
my @builds = $c->stash->{eval}->builds;
$self->status_ok(
$c,
entity => [@builds],
);
}

Copy link
Contributor

@Mindavi Mindavi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tried this out on my local instance and on hydra.nixos.org, and indeed this endpoint exists! Thanks for documenting it, it's a very useful endpoint and prevents having to scrape html or do hundreds of thousands of requests (if you want to check all builds in a nixpkgs eval...)

@sternenseemann
Copy link
Member Author

sternenseemann commented Aug 30, 2023

I think it has a lot of potential, especially for e.g. nix-review-tools which currently scrapes the jobset overview HTML with ?full=1 passed. However, the endpoint is very slow at the moment which can hopefully be helped somehow, though.

It is actively used by hydra-report.hs in maintainers/scripts/haskell.

@dasJ dasJ merged commit 8520ab1 into NixOS:master Sep 9, 2023
1 check passed
@sternenseemann sternenseemann deleted the doc-eval-builds branch September 9, 2023 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants