Make the package check world aware of ignored files
A pull request for this has already been merged.
- #69 by @saecki — merged
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 48/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- github-actions, rust
- Domain
- build-system, ci-cd
Research direction
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.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- Rust
- Stars
- 37
- Forks
- 9
- Avg merge
- 7d 3h
- Merged PRs (30d)
- 6
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from typst/package-check
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
typst/package-check#94 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
typst/package-check#95 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
typst/package-check#91 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
typst/package-check#90 · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
typst/package-check#73 · 1 comment ·
All issues in typst/package-check
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
pierreaubert/gpui-toolkit#114 ·
Maintainers usually reply within 1 day
-
BibLaTeX `type` keys like `phdthesis`, `mathesis`, `techreport` are printed raw instead of localizedOpen
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
Maintainers usually reply within 1 day
-
compiler
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
HerringtonDarkholme/hd-lang#1853 ·
Maintainers usually reply within 1 day
-
bug needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
pbakaus/impeccable#1462 ·
Maintainers usually reply within 1 day