Record what an update follows and the installed commit in `.quarto-source.yml`

Abierto
#1,178 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
55/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
rust, yaml
Área
cli

Línea de trabajo

Start by finding the code that reads and writes .quarto-source.yml records and the schema for version 1; the issue does not name specific files or tests. Check how install sources determine the tracking mode and commit, including @<sha> installs. Done means records can include optional track and commit keys while existing records without them remain accepted.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Description
Context

The record has source, kind, and an optional ref.
ref is what the user typed, not what was installed.
A plain owner/repo installs the head of the default branch.
The record doesn't say which commit that was, nor whether a later update should follow the branch or the latest release.
A future q2 update can't tell whether the branch has moved.

Other tools need the same two facts.
The development version of Quarto Wizard keeps them for now in its own quarto-wizard: block, and would move to keys that q2 defines.

Proposal

Add two optional keys to schema version 1 of the record:

version: 1
source: acme/demo
kind: github
track: branch   # tag | branch: what an update follows
commit: 3f2a9c1e5b7d4a60918c2d4e6f8a0b1c3d5e7f90   # full SHA of what is installed
files:
  _extension.yml: <sha256>
  filter.lua: <sha256>

Both are optional, so the readers of today still accept the file.
q2 writes commit when it knows it, for example for an @<sha> install, and track from how the user installed.

Why

What an update follows and what is installed both describe the install, and the record is where q2 keeps that.

Benefits

q2 update can tell from the record alone whether a branch has moved.
A committed record shows exactly which commit a project uses.
Other tools, such as Quarto Wizard or a future official q2 extension for Positron and VS Code, can read the same keys instead of keeping their own.

Related:

Lenguaje dominante
Rust
Estrellas
302
Forks
22
Merge medio
5 h 2 min
PR fusionados (30 d)
213

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de quarto-dev/q2

Todos los issues de quarto-dev/q2

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.