mirror-get-aurora-dev-common/README.md
2026-10-12 08:07:47 +03:00

88 lines
2.5 KiB
Markdown

# aurora-common
Shared OCI layer containing configuration files for https://github.com/ublue-os/aurora.
This repo builds on top of:
- https://github.com/get-aurora-dev/branding
- https://github.com/ublue-os/artwork
- `system_files/shared/` - Configuration shared between Aurora and Aurora-DX
- `system_files/dx/` - Aurora-DX specific configuration
- `wallpapers/` - Aurora wallpapers from [artwork repo](https://github.com/ublue-os/artwork)
- `system_files/shared/usr/share/ublue-os/homebrew/` - Flatpak definitions used for including flatpaks for the ISOs and `ujust install-system-flatpaks` - [Yes, homebrew supports the installation of Flatpaks](https://github.com/Homebrew/brew/pull/21097)
- `logos/` - Aurora Logos used in PLM/Plasma Kickoff etc.
Related work is on the [Fedora KDE-SIG](https://forge.fedoraproject.org/kde)
- [kde-settings](https://forge.fedoraproject.org/kde/kde-settings)
## Usage in Downstream Projects
Aurora images reference this layer in their Containerfiles:
```dockerfile
FROM ghcr.io/get-aurora-dev/aurora-common:latest AS aurora-common
# Copy shared configuration
COPY --from=aurora-common /system_files/shared /
# Copy DX-specific configuration (Aurora-DX only)
COPY --from=aurora-common /system_files/dx /
# Copy wallpapers
COPY --from=aurora-common /wallpapers /
# Copy other assets as needed
COPY --from=aurora-common /logos /tmp/logos
```
## Verify authenticity with cosign
Images are dual-signed so they can be verified with the old sigstore bundle format as well as the keyless OIDC way.
```
cosign verify \
--certificate-oidc-issuer https://token.actions.githubusercontent.com \
--certificate-identity-regexp="github.com/get-aurora-dev/common/.github/workflows/*" \
ghcr.io/get-aurora-dev/common:latest
```
## Building Locally
```bash
just build
```
## How to test changes
This is not as thorough as building this container, and building Aurora itself with that local copy but is mostly good enough for quick iteration.
Use [sysextbuddy](https://github.com/tulilirockz/sysextbuddy/). It is currently limited to `/usr` because `--install-mode confext` for `/etc` is currently harder to do because of selinux.
```
sysextbuddy -i system_files/shared
```
Things that are generated/modified during the container build like wallpapers are missing here so do `just dump` and then
```
sysextbuddy -i dump/system_files/shared
```
instead.
## Additional Commands
```bash
# Check Just syntax
just check
# Fix Just formatting
just fix
# Inspect image structure
just tree
# Dump image contents to ./dump
just dump
```