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

Đang mở
#1,178 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
55/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
rust, yaml
Lĩnh vực
cli

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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:

Ngôn ngữ chính
Rust
Star
302
Fork
22
Merge trung bình
5 giờ 2 phút
Pull request đã merge (30 ngày)
213

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của quarto-dev/q2

Tất cả issue của quarto-dev/q2

Issue tương tự

Thêm issue về Rust

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.