| ... | ... | @@ -122,13 +122,14 @@ This ensures that commits can only be pushed to `wip/.*`, which the submodule ch |
|
|
|
|
|
|
|
`Haddock` is quite closely tied to GHC. Consequently, there is one `haddock` branch for each GHC major release series (e.g. haddock's `ghc-8.6` for GHC's `ghc-8.6` branch). Meanwhile, GHC's `master` branch follows `haddock`'s `ghc-head` branch.
|
|
|
|
|
|
|
|
Meanwhile, development of `haddock` itself occurs on GHC's current major release branch. This is then periodically merged into `ghc-head`.
|
|
|
|
Meanwhile, development of `haddock` itself occurs on a branch that corresponds to GHC's current major release. This branch is then periodically merged into `ghc-head`.
|
|
|
|
|
|
|
|
#### Dealing with haddock changes as ghc dev.
|
|
|
|
#### Dealing with haddock changes as a GHC developer
|
|
|
|
|
|
|
|
As ghc dev what this means for you is you need to:
|
|
|
|
To land a GHC MR that requires changes to haddock, you will need to coordinate your GHC MR with a Haddock MR, made to the `ghc-head` branch of `Haddock` **on GitLab**. The workflows is as follows:
|
|
|
|
|
|
|
|
* Create your patch to haddock such that ghc+haddock both build+work together. Similar to how it's described above.
|
|
|
|
* Open an MR against haddocks ghc-head branch *on gitlab*
|
|
|
|
* Get your ghc MR to pass CI and get merged.
|
|
|
|
* Merge the ghc-head MR once the ghc MR has been merged. |
|
|
\ No newline at end of file |
|
|
|
* Create your GHC MR which includes a change to the haddock submodule. The haddock commit should belong to a branch of the **GitLab** Haddock repository.
|
|
|
|
* Get your MR in a mergeable state: approved and passing CI. The `lint-submods` test should give a warning at this point, but it will not cause the CI to fail.
|
|
|
|
* Open an MR against the `ghc-head` branch of Haddock **on GitLab**, and get it merged.
|
|
|
|
* If necessary, update the GHC MR to point to the correct ghc-head haddock commit. If the commit hash didn't change, then you can skip this step.
|
|
|
|
* At this point, the GHC MR should be passing CI, **including** the `lint-submods` test. It can then be merged. |
|
|
\ No newline at end of file |
