Skip to content

Commit 7c2c349

Browse files
committed
add README checklist entry for adapting the workflow
1 parent 2a5d6d9 commit 7c2c349

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ A short description about the project and/or client.
1313
- See also the [typst/packages README](https://github.com/typst/packages/?tab=readme-ov-file#package-format)
1414
- [ ] Adapt Repository URLs in `CHANGELOG.md`
1515
- Consider only committing that file with your first release, or removing the "Initial Release" part in the beginning
16+
- [ ] Adapt or deactivate the release workflow in `.github/workflows/release.yml`
17+
- to deactivate it, delete that file or remove/comment out lines 2-4 (`on:` and following)
18+
- to use the workflow
19+
- [ ] check the values under `env:`, particularly `REGISTRY_REPO`
20+
- [ ] if you don't have one, [create a fine-grained personal access token](https://github.com/settings/tokens?type=beta) with [only Contents permission](https://stackoverflow.com/a/75116350/371191) for the `REGISTRY_REPO`
21+
- [ ] on this repo, create a secret `REGISTRY_TOKEN` (at `https://github.com/[user]/[repo]/settings/secrets/actions`) that contains the so created token
22+
23+
if configured correctly, whenever you create a tag `v...`, your package will be pushed onto a branch on the `REGISTRY_REPO`, from which you can then create a pull request against [typst/packages](https://github.com/typst/packages/)
1624
- [ ] remove/replace the example test case
1725
- [ ] (add your actual code, docs and tests)
1826
- [ ] remove this section from the README

0 commit comments

Comments
 (0)