Install the default branch through `archive/HEAD` instead of trying `main` then `master`

Aperta Adatta ai principianti
#1,179 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
73/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
rust
Ambito
backend

Direzione di ricerca

Inizia in crates/quarto-source-fetch/src/target.rs, dove i target semplici owner/repo provano attualmente gli archivi main e master. Leggi la gestione del download dell’archivio e dei reindirizzamenti, poi controlla come viene registrato il commit risolto. Il lavoro è completato quando un repository semplice viene installato dal suo branch predefinito su GitHub, anche se quel branch ha un altro nome.

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

Descrizione

Description
Context

For a plain owner/repo, crates/quarto-source-fetch/src/target.rs tries archive/refs/heads/main, then archive/refs/heads/master.
When the default branch has another name, q2 either fails, or installs a branch that isn't the default.

https://github.com/mcanouil/q2-default-branch-demo shows the second case.
Its default branch is develop, with the demo extension at version 2.0.0.
An older main branch has the same extension at version 1.0.0.

$ q2 add mcanouil/q2-default-branch-demo --trust --no-prompt
The following changes will be made in .:
  Demo  [Install]      1.0.0  (filter)

q2 installs version 1.0.0 from main.
The record it writes has no ref and no commit, so nothing shows later that the install came from a branch that isn't the default:

version: 1
source: mcanouil/q2-default-branch-demo
kind: github
files:
  _extension.yml: b57dd1f9313c1b622ed19918e48134119762128b5612b709918317c10b63cef3
  demo.lua: 2150321a3a3a341aebde685226d403639b195ff507c1a45b9b6ab23fc4ee5f26
Proposal

Download https://github.com/<owner>/<repo>/archive/HEAD.tar.gz for the default branch.
GitHub answers with a redirect that names the commit at the head of the default branch:

$ curl -sI https://github.com/mcanouil/q2-default-branch-demo/archive/HEAD.tar.gz | grep -i '^location'
location: https://codeload.github.com/mcanouil/q2-default-branch-demo/tar.gz/0cb98bf577f198e0417d163bc589e8dfb9ae2e96

archive/refs/heads/main redirects to .../tar.gz/refs/heads/main, with no commit.

Why

It removes the guess at the branch name, and needs no API call or token.

Benefits

q2 add owner/repo installs the default branch of any repository, whatever its name.
q2 learns the installed commit for free, which https://github.com/quarto-dev/q2/issues/1178 needs.
Other tools that install from GitHub, such as Quarto Wizard, can use the same URL and get the same commit for the same input.

Related:

Lingua principale
Rust
Stelle
302
Fork
22
Merge medio
5h 2m
PR unite (30g)
213

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di quarto-dev/q2

Tutte le issue di quarto-dev/q2

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.