Clarify instructions based on feedback

This commit is contained in:
Zach Alberico 2023-01-13 19:20:17 -08:00
parent b7cc0fc4bc
commit 7438ddd30f

View File

@ -14,18 +14,15 @@ also simple to reason about.
The branches and their corresponding moons that comprise the stages of the
release pipeline are:
--------------------------------------------------------------
Branch | Moon | Target audience
--------------------------------------------------------------
`develop` | `~binnec-dozzod-marzod` | Kernel developers
`release` | `~marnec-dozzod-marzod` | Early Adopters
`release` | `~doznec-dozzod-marzod` | App Developers
`master` | `~zod` | Everyone else
----------------------------------------------------------------------------------------------
Branch | Moon | Target audience | Contains
----------------------------------------------------------------------------------------------
`develop` | `~binnec-dozzod-marzod` | Kernel developers | Latest `develop` branch commit
`release` | `~marnec-dozzod-marzod` | Early Adopters | Latest `release` branch commit
`release` | `~doznec-dozzod-marzod` | App Developers | Latest release candidate
`master` | `~zod` | Everyone else | Latest release
`~binnec` Every commit merged to develop is deployed to `binnec`
`~marnec` Every release branch commit is deployed to `marnec`
`~doznec` Late stage release candidates go to `~doznec`
`zod` `zod` distributes the new kernel to the general public
**WARNING**: If you lack the requisite skills to troubleshoot and fix kernel issues, you should not sync from develop/~binnec. If you're not prepared to breach your ship in response to an issue stemming from an early release, do not use pre-release moons.
`develop` is the default branch in the repo, which means that all new pull
requests target it by default. The general flow of a new feature or bug fix
@ -104,5 +101,5 @@ You can get the "contributions" section by the shortlog between the last release
and this release:
```
git shortlog LAST_RELEASE.. --no-merges
git shortlog --no-merges LAST_RELEASE..
```