PR#1: Add spin policy and guidelines - centos/sig-guide

centos / sig-guide

#1 Add spin policy and guidelines

Merged 2 years ago by bstinson. Opened 2 years ago by dcavalca.

centos/ dcavalca/sig-guide spin into master

Correct spin release package name and clarify its usage

Davide Cavalca • 2 years ago

370c72

Add spin policy and guidelines

Davide Cavalca • 2 years ago

a080a2

docs/index.md

file modified

		`@@ -11,4 +11,5 @@`
		`* How to start [building](cbs.md) RPM packages or other artifacts`
		`* How to [test](ci.md) your packages`
		`* How to [push to mirror](delivery.md) network`
		`+ * How to create a CentOS [spin](spin.md)`
		`* Rules for [dns entries](dns.md) under sig.centos.org`

docs/spin.md

file added

+23

		`@@ -0,0 +1,23 @@`
		`+ # CentOS SIG spin policy and guidelines`
		`+`
		+ 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.
		`+`
		`+ ## Making a spin`
		`+ To create a new spin, you will need a few dedicated packages to properly identify the spin:`
		+ - 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
		+ - 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))
		`+`
		+ 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.
		`+`
		+ 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).
		`+`
		`+ Spins produced by a SIG should be documented on its wiki page as deliverables.`
		`+`
		`+ ## Branding`
		`+ 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.`
		`+`
		`+ ## Distribution`
		`+ 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.`
		`+`
		`+ ## Discontinued spins`
		`+ 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.`

mkdocs.yml

file modified

		`@@ -13,6 +13,7 @@`
		`- ci.md`
		`- delivery.md`
		`- dns.md`
		`+ - spin.md`

		`theme:`
		`name: material`

dcavalca commented 2 years ago

As discussed in the last board meeting, add the approved spin policy to the SIG guide. More context on this in https://git.centos.org/centos/board/issue/45

ngompa commented on line 8 of docs/spin.md 2 years ago

The formula here is centos-release-$name-spin for the repo package. This centos-release-$name-spin package is specific to enabling a repo for spin packages. This probably means you need to add guidance here about a spin repo from a SIG.

dcavalca commented on line 8 of docs/spin.md 2 years ago

I suspect I named it this way on purpose, despite the conflict with the one that Hyperscale is currently using, as I remember there was a bunch of discussion around naming when this was first proposed. I don't actually care about the name, but I want to make sure I'm not misrepresenting what was actually approved by the board. @rbowen @alphacc: do you happen to remember more / have notes about this discussion?