Repository setup
This page is the concrete checklist for the upstream repository. A fork follows the same steps with its own names.
Repository
Section titled “Repository”Push to a public GitHub repository with main as the default branch, enable Actions, and
choose GitHub Actions as the Pages source.
Configure the github-pages environment to allow deployment from version tags such as v* —
its default-branch restrictions otherwise reject tag builds.
The APK URL
Section titled “The APK URL”The distribution repository uses a custom Pages domain:
https://repo.uflinux.org/apk/v3.24/uflinuxPoint the repo DNS record (a CNAME to the github.io site) at GitHub Pages and set the
same custom domain in Settings → Pages. Forks and other repositories fall back to
https://OWNER.github.io/REPO/apk/v3.24/uflinux inferred from GITHUB_REPOSITORY (account-site
repositories are handled automatically), and an APK_REPOSITORY_URL Actions variable
overrides either default.
Signing secrets
Section titled “Signing secrets”Prepare a persistent EC P-256 or P-384 keypair locally, outside the build workspace, in
$HOME/.config/uflinux3-signing/ — $HOME/.config/uflinux is the desktop’s own preference
directory. Follow the commands in CI and publishing, and keep
the directory and private key owner-restricted and out of Git.
In Settings → Secrets and variables → Actions, add:
| Secret | Contents |
|---|---|
APK_SIGNING_PRIVATE_KEY |
Complete PEM contents of uflinux.ec |
APK_SIGNING_PUBLIC_KEY |
Complete PEM contents of uflinux.ec.pub |
Both must hold the EC key above; a previously uploaded RSA pair is rejected by the build rather than silently accepted. apk v2 has no ECDSA signature type, so the key is carried in the SHA-256 signature stream — see Maintenance.
The separate apps repository that publishes uflinux-files is signed by its own key,
uflinux3.ec384.pub, pinned in the apps section of the source lock.
Back up the private key before publishing a release. Do not commit it or paste it into issues, logs or chat.
What each run does
Section titled “What each run does”- Pushes to
mainand manual dispatch build development images without release secrets. - A version tag builds the release package set and exposes the key only to trusted signing, assembly and publication jobs.
- Publication is gated on all six architecture checks plus native integration and reproducibility records.
- Pages keeps three release generations and checks the complete bundle’s size before deploying.
First run
Section titled “First run”python3 scripts/check.py # run before pushinggit tag v0.1.0git push origin v0.1.0Run the workflow manually first to inspect development artifacts, then tag.
Adopting a fork
Section titled “Adopting a fork”Two placeholders need replacing before a public release:
- the reserved
[email protected]packager identity, which is a syntactically valid default and not a monitored support address; - the package project URL, which should point at your actual repository.
See Maintenance for what else changes when you take over a fork.
Derived from docs/github-setup.md inUFlinux-project/uflinux3(b4f4817). Report documentation problems inUFlinux-project/docs.