Make the package check world aware of ignored files

Aperta
  • Qualcosa non va?
#102 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Una pull request collegata è già stata integrata.

  • #69 di @saecki — integrata

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
github-actions, rust
Ambito
build-system, ci-cd

Direzione di ricerca

Start by locating the package validation flow and any existing GitHub Actions workflows in the repository. Check how submitted package files are made available to validation, then identify how to invoke the latest Typst compiler on a template. Done means a CI check compiles the submitted template and reports failures before its package PR can merge.

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

Descrizione

Description

As described in the title, it would be of tremendous help for package and template authors if there was a GitHub CI check implemented that verified that a submitted template actually compiles with the latest version of Typst, given the files that are submitted in the PR.

For instance, if a resource is missing (e.g. a logo that was excluded due to .gitignore), or if there is some issue with the Typst source code (e.g. absolute/relative paths, etc), this would be caught by the GitHub CI check automatically.

I've personally been hit by this twice or thrice (see e.g. typst/packages#6341 typst/packages#3130 typst/packages#3143 typst/packages#6340), and having such a check would ensure that a template for a package always compiles before the PR is merged into the Typst Universe ecosystem.

This would also help relieve some of the effort currently placed on @elegaanz and others reviewing the submitted packages and templates.

From https://github.com/typst/packages/pull/6341#issuecomment-6744938052

Ah yes, .gitignore files are a bit of a footgun in packages. Sorry that it was not caught in the previous review.

Having all of these things in ones head may be possible, but that effort is better spent on automated checks, so that Ana and others reviewing can focus on the larger issues and give better feedback on canonical use of Typst.

Lets build these checks to help the Typst ecosystem flourish even more ❤️

With joy and gratitude.
/Robin

Moved here from https://github.com/typst/packages/issues/6358

Lingua principale
Rust
Stelle
37
Fork
9
Merge medio
7g 3h
PR unite (30g)
6

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 typst/package-check

Tutte le issue di typst/package-check

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.