Blame docs/spin.md

a080a2
# CentOS SIG spin policy and guidelines
a080a2
a080a2
CentOS SIGs can create spins of the distribution if they so desire. A spin in this context is defined as an alternative distribution deliverable (e.g. ISO install image, LiveDVD image, cloud image, etc.) with SIG specific customizations that deviate from the stock CentOS deliverables. For example, the [Hyperscale SIG ](https://wiki.centos.org/SpecialInterestGroup/Hyperscale) is currently producing a [Workstation spin](https://lists.centos.org/pipermail/centos-devel/2021-July/077156.html) delivered as a LiveDVD.
a080a2
a080a2
## Making a spin
a080a2
To create a new spin, you will need a few dedicated packages to properly identify the spin:
370c72
- add a `centos-release-$name-spin` subpackage to your SIG release package ([example](https://git.centos.org/rpms/centos-release-hyperscale/blob/c8s-sig-hyperscale/f/SPECS/centos-release-hyperscale.spec)); this subpackage should either require or include any repository definitions that are needed for the spin to work
a080a2
- branch [`centos-stream-release`](`https://git.centos.org/rpms/centos-stream-release) and add a `centos-stream-spin-$name-release` subpackage to it; make sure to set `VARIANT` and `VARIANT_ID` in [os-release](https://www.freedesktop.org/software/systemd/man/os-release.htmll#VARIANT=) to properly identify the spin and to add a `Requires` for the spin release package ([example](https://git.centos.org/rpms/centos-stream-release/blob/c8s-sig-hyperscale-spin/f/SPECS/centos-stream-hyperscale-spin-release.spec))
a080a2
a080a2
Within these packages, `$name` should either be the name of the SIG (if producing only one spin), or the name of the SIG followed by the name of the spin.
a080a2
370c72
We recommend using a dedicated destination tag in CBS for spin-specific packages, and including the corresponding repository definition in your `centos-release-$name-spin` subpackage. This is especially important if the spin includes packages that will only work properly within the spin itself (i.e. they are not suitable for installation on stock CentOS systems).
a080a2
a080a2
Spins produced by a SIG should be documented on its wiki page as deliverables.
a080a2
a080a2
## Branding
a080a2
CentOS spins are part of the CentOS Project, in the same way that other SIG deliverables are. Spins should strive to comply with all project policies, guidelines and best practices. SIGs are required to clearly identify spins as such, but are otherwise allowed to use the CentOS logo and name as part of spins they may produce like for any other deliverables.
a080a2
a080a2
## Distribution
a080a2
Spin deliverables should be build in CBS and distributed via the mirror network. This isn't a requirement for experimental and work-in-progress deliverables, as long as they're clearly marked as such.
a080a2
a080a2
## Discontinued spins
a080a2
SIGs should review the content they produce during their quarterly review. If the SIG has announced their intention to no longer maintain a spin, it will be removed from the mirrors.