docs(sirius-press): say that the forge repo is a mirror, and what that costs
Someone who clones from code.silentmode.st and starts working will otherwise find out the hard way: push-split.sh force-pushes master, so their branch does not survive the next mirror push. Better to say it on the page that tells people how to take an upstream release, since that is exactly the work that would be lost.
This commit is contained in:
parent
961cb108ca
commit
a65556726e
1 changed files with 22 additions and 0 deletions
|
|
@ -121,6 +121,28 @@ replaced from plugins precisely so they would never appear in this directory.
|
|||
|
||||
---
|
||||
|
||||
## Where this repository lives
|
||||
|
||||
`code.silentmode.st/silentmode/sirius-press` is a **mirror**. Sirius Press is
|
||||
developed inside the Silent Mode monorepo and split out with
|
||||
`scripts/push-split.sh`, which force-pushes `master` each time. History on the
|
||||
forge is real — file blame points at the actual commits — but it is rewritten
|
||||
on every push, so a pull request against it will not survive.
|
||||
|
||||
What that means in practice:
|
||||
|
||||
- **Silent Mode takes upstream releases in the monorepo**, where the subtree's
|
||||
merge history is intact, and the result is mirrored here.
|
||||
- **A downstream fork** that clones from the forge and wants to bump WordPress
|
||||
itself should treat its clone as the source of truth from that point on and
|
||||
stop pulling the mirror, because the next mirror push will not merge with
|
||||
its work.
|
||||
|
||||
Patches and bug reports are welcome as issues; code is easiest to take as a
|
||||
diff rather than as a branch.
|
||||
|
||||
---
|
||||
|
||||
## If the upstream branch is missing
|
||||
|
||||
A clone made with `--single-branch` will not have
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue