netlify / netlify/open-api

Add API endpoint to search for a specific deploy preview

Open
#380 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
323
Forks
133
Avg merge
2d 8h
Merged PRs (30d)
2

Description

As a developer,
I want to find the build status for a build at a specific git commit.

At the moment I must run listSiteBuilds, and filter by the data.sha matching pull/[PR_NUMBER]/head, to get a build information containing a deploy_id which I can then query the status of.

It would be ideal if there were a listSitePreviews function accepting an optional commit head filter and/or pull request filter.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing listSiteBuilds function and its data.sha filtering flow. Compare that entry point with the proposed listSitePreviews function, decide how optional commit-head and pull-request filters should be represented, and verify that the result exposes the deploy information needed to query status.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, openapi
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.