coder / coder/internal

Git Flow: coder/coder: implement endpoint to query branches from git remote

Aperta
#405 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
s
Lingua principale
Nessun dato sulla lingua
Stelle
3
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Related to https://github.com/coder/internal/issues/404

In order to improve usability of Git repos, we want to have a way to quickly signal to the user if
- a Git repo they attempt to clone does not exist,
- the branch of the repo they attempted to clone does not exist,
- the user does not have the permission to clone the remote repo

Currently this is only detected when building the workspace, but ideally we should detect this up-front while the user is creating a workspace.

Add an endpoint in `coderd` to query a remote Git repo and return the list of branches on the remote:

```
GET /api/v2/users/{user}/git_repo/branches?repo={repo}&provider={provider_id}
```

* `git_repo` (required) should be the git URL of a remote repo to be queried
* If `provider` is set, authenticate with the provider using the logged in user's OAuth2 credentials. Otherwise assume no authentication.

Implementation notes:

* To query the remote branches, we can use an approach similar to `https://github.com/go-git/go-git/blob/main/_examples/ls-remote/main.go`
* We can also perform a basic syntax check of the Git repo URL using e.g. [github.com/chainguard-dev/git-urls](https://pkg.go.dev/github.com/chainguard-dev/git-urls). We should only warn and not block if the URL syntax appears incorrect; the likelihood of false positives is non-zero.
* Success criterion: we should be able to list remote branches of both Linux and Chromium without exploding 🙈

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Start at the coderd API routing for the proposed GET /api/v2/users/{user}/git_repo/branches endpoint, then read the go-git ls-remote example and the git-urls package notes. Implement the unauthenticated and provider OAuth2 cases, and verify that remote branches can be listed for Linux and Chromium repositories.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
git, go
Ambito
api, authentication, backend
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.