Skip to content

fix: address typst-package-check feedback for 0.3.0 submission#7

Merged
smur89 merged 1 commit into
mainfrom
fix/typst-universe-checks
Jun 11, 2026
Merged

fix: address typst-package-check feedback for 0.3.0 submission#7
smur89 merged 1 commit into
mainfrom
fix/typst-universe-checks

Conversation

@smur89

@smur89 smur89 commented Jun 11, 2026

Copy link
Copy Markdown
Owner

The Typst Universe automated check on altacv 0.3.0 raised two errors and two warnings. This PR addresses all four; once merged, release-please cuts a 0.3.1 patch with the corrected manifest + README.

Errors

  • README.md:62examples/example.typ and tests/ are referenced via relative links, but those directories are intentionally excluded from the package bundle (only typst.toml, lib.typ, icons/, LICENSE, README.md ship). The dangling links failed the bundle integrity check. Replaced with a textual mention plus one link to the source repository.

Warnings

  • typst.toml:7description started with "Typst CV template …"; the manifest guidelines say the field should generally not contain the word Typst (every Universe package is Typst by definition).
  • README.md:9 — hero image's alt text was just Preview. Replaced with a descriptive sentence covering layout and section content for accessibility.

Follow-up

After merge, release-please will open a release PR proposing 0.3.1. Merging that cuts the tag + release. Submission of altacv:0.3.1 to typst/packages will:

We should also close typst/packages#5037 once 0.3.1 is submitted — the 0.3.0 directory in that PR has the unfixed README/manifest and cannot be patched in place without inconsistency with the released tarball.

The automated check on typst/packages#5037
flagged three issues that prevent altacv from passing review:

1. README links to `examples/example.typ` and `tests/` resolved to
   paths inside the package bundle, but those directories are
   intentionally excluded from the tarball. Replaced with a textual
   reference plus one link to the source repository root.

2. The hero image's alt text was just "Preview", flagged as
   inadequate for accessibility. Replaced with a descriptive
   sentence covering the two-column layout and section content.

3. typst.toml `description` started with "Typst CV template" —
   Typst's manifest guidelines say the field should generally not
   contain the word `Typst` since every Universe package is by
   definition Typst-targeted. Dropped the leading "Typst".
@smur89 smur89 merged commit 9560452 into main Jun 11, 2026
4 checks passed
@smur89 smur89 deleted the fix/typst-universe-checks branch June 11, 2026 18:01
smur89 pushed a commit that referenced this pull request Jun 11, 2026
🤖 I have created a release *beep* *boop*
---


## [0.3.1](v0.3.0...v0.3.1)
(2026-06-11)


### Bug Fixes

* address typst-package-check feedback for 0.3.0 submission
([#7](#7))
([9560452](9560452))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
smur89 added a commit that referenced this pull request Jun 11, 2026
…one (#11)

The auto-submit job failed at the clone step in the 0.3.1 release run:

```
From https://github.com/typst/packages
 * [new branch]          main       -> upstream/main
error: remote upstream already exists.
```

## Root cause

`gh repo clone <fork>` detects when the target is a fork and
auto-configures an `upstream` remote pointing at the parent — visible in
the failed run's log just before our error (the "new branch main ->
upstream/main" line). Our explicit `git remote add upstream` then
collides.

## Fix

- Drop `git remote add upstream` (gh already did it).
- Drop the redundant follow-up `git fetch upstream main --depth=1` (gh's
auto-clone already fetched it as `upstream/main`).
- Add `--depth=1` to the `gh repo clone` itself. The fork mirrors all of
typst/packages (~70k files) and the 0.3.1 run spent 55s on the
working-tree update alone; a single-commit shallow clone is enough to
branch off `upstream/main` and push the new package directory.

## Verifying

This can only be tested by another release. Options:

1. Cut a fresh patch release (e.g. a doc-only change → `fix:` → 0.3.2)
and watch the auto-submit job run.
2. **Or** I can submit `altacv:0.3.1` manually one more time (the 0.3.1
release has the corrected README + manifest from PR #7) while this
lands, then the next release after that will exercise the auto path.

I'd suggest option 2 — it gets altacv onto Typst Universe sooner. Want
me to do the manual submit while this PR is open for review?

Co-authored-by: Shane Murphy <shane@swissborg.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant