| ... | ... | @@ -2,96 +2,31 @@ This is GHC's GitLab instance. GitLab has replaced Trac and Phabricator as the c |
|
|
|
|
|
|
|
You may wish to see the [table of contents](./index) to get a sense for what is available in this Wiki.
|
|
|
|
|
|
|
|
<!--
|
|
|
|
To generate images with borders:
|
|
|
|
```
|
|
|
|
mkdir -p shadow
|
|
|
|
rm shadow/*
|
|
|
|
for i in *.png; do
|
|
|
|
nix run nixpkgs.imagemagick -c \
|
|
|
|
convert $i -bordercolor white -border 50 \
|
|
|
|
\( +clone -background black -shadow 80x5+2+2 \) \
|
|
|
|
+swap -background white -layers merge +repage \
|
|
|
|
shadow/$i
|
|
|
|
done
|
|
|
|
```
|
|
|
|
-->
|
|
|
|
# Quick Links
|
|
|
|
|
|
|
|
# Logging in
|
|
|
|
* [GHC Home](https://www.haskell.org/ghc/) GHC's home page
|
|
|
|
* [GHC User's Guide](https://www.haskell.org/ghc/) Official user's guide for current and past GHC releases.
|
|
|
|
* Joining In
|
|
|
|
* [Newcomers info](/contributing#newcomers-to-ghc) / [Contributing](/contributing) Get started as a contributor.
|
|
|
|
* [Mailing Lists & IRC](/mailing-lists-and-irc) Stay up to date and chat to the community.
|
|
|
|
* [The GHC Team](/team-ghc) Contributors and who is responsible for what.
|
|
|
|
* Documentation
|
|
|
|
* [GHC Status Info](/status#ghc-status) How is the next release coming along?
|
|
|
|
* [Working conventions](/contributing#contributing-to-ghc) How should I do X?
|
|
|
|
* [Building Guide](/building/#building-and-porting-ghc) Build GHC from source.
|
|
|
|
* [Commentary](/commentary/#the-ghc-commentary) Explaining the GHC source code.
|
|
|
|
|
|
|
|
If you had a Trac account then you likely already have a GitLab account as a result of the Trac import. This account will have a username of the form `trac-$TRAC_USERNAME`. You can reset your password with the [Forgot your password?](https://gitlab.haskell.org/users/password/new) dialogue. Once you have gained access to this account you may change your username to remove the `trac-` prefix
|
|
|
|
|
|
|
|
If you do not have a Trac account (or would prefer to start from scratch with a new account) you can [log in](https://gitlab.haskell.org/users/auth/github) using your GitHub account or [create](https://gitlab.haskell.org/users/sign_in) a new GitLab account.
|
|
|
|
|
|
|
|
As a last resort, please contact @bgamari with your email address.
|
|
|
|
|
|
|
|
# Merge requests
|
|
|
|
|
|
|
|
Submitting a patch for incorporation into the tree is done by creating a *merge request*. The merge request serves as a place to conduct code review, collect continuous integration results, and eventually merge your patch.
|
|
|
|
|
|
|
|
## Opening a merge request
|
|
|
|
|
|
|
|
To open a merge request:
|
|
|
|
|
|
|
|
1. Push your branch. You may push either to your fork or the primary `ghc/ghc` project.
|
|
|
|
2. Starting from the [GHC GitLab project](https://gitlab.haskell.org/ghc/ghc) click on the *Merge Requests* link in the left navigational bar.
|
|
|
|
3. Click on the green *New Merge Request* button on the top right corner of the Merge Requests page
|
|
|
|
4. In the left drop-down of the *Source branch* pane select the project to which you pushed your branch.
|
|
|
|
5. In the right drop-down of the *Source branch* pane select the name of your branch.
|
|
|
|
6. Click on the green *Compare branches and continue* button.
|
|
|
|
7. Give your merge request a title
|
|
|
|
8. Write a description of your change. This should be ideally at very least a few sentences to help reviewers understand what you have done.
|
|
|
|
9. Click on the green *Submit merge request* button.
|
|
|
|
|
|
|
|
## Working with your merge request
|
|
|
|
|
|
|
|
Your merge request shows you several panes information:
|
|
|
|
|
|
|
|
Top-most is the request's title and description. These can be edited by pressing the yellow `Edit` button on the top-right corner of the page.
|
|
|
|
|
|
|
|
The next pane summarises your merge request, showing the the source and target branches.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The next pane shows the status of the merge request's continuous integration builds. If the build has failed you can click on the red *X* icon to see the build log.
|
|
|
|
|
|
|
|
|
|
|
|
# Migration from Trac
|
|
|
|
|
|
|
|
At the bottom of the page is the code review interface, consisting of several tabs:
|
|
|
|
## Logging in
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The *Discussion* tab shows a summary of the comments left on the change. This includes comments left in-line in the code, as well as those independent of the code.
|
|
|
|
|
|
|
|
The *Commits* tab lists the commits being proposed for merge. These may be clicked upon to restrict the diff to only changes made by that commit.
|
|
|
|
|
|
|
|
The *Pipelines* tab provides a more detailed overview on the state of the various continuous integration jobs associated with the merge request.
|
|
|
|
|
|
|
|
Finally, the *Changes* tab shows the patch itself. This view may be restricted to changes made by a single commit by selecting the commit in the *Commits* tab. Moreover, one may view previous iterations of the merge request using the two drop-down menus at the top of the tab. To leave an inline comment click on a line in the patch.
|
|
|
|
|
|
|
|
## Merging your merge request
|
|
|
|
|
|
|
|
Currently we merge MRs with the aid of @marge-bot. After your MR has been reviewed and approved by a GHC developer you can flag it for merge by assigning it to @marge-bot using the "Assignee" field in the right sidebar:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
As long as your MR satisfies the following, marge will batch your MR with other MRs and attempt to merge into master:
|
|
|
|
|
|
|
|
* Assigned to Marge
|
|
|
|
* Approved by a GHC developer
|
|
|
|
* Passing CI
|
|
|
|
* Has no merge conflicts with master (see rebasing below)
|
|
|
|
|
|
|
|
Each batch is an MR and must pass CI, so you can expect Marge to merge 2 or 3 batches per day. She will usually comment on your MR to inform you of progress, but you can also view the status of Marge's batches/MRs [on GitLab](https://gitlab.haskell.org/ghc/ghc/merge_requests?scope=all&utf8=%E2%9C%93&state=all&author_username=marge-bot).
|
|
|
|
|
|
|
|
### Rebasing
|
|
|
|
|
|
|
|
You generally do NOT need to rebase your MRs unless there are merge conflicts with master. Marge will automatically rebase ontop of master when batching MRs.
|
|
|
|
If you had a Trac account then you likely already have a GitLab account as a result of the Trac import. This account will have a username of the form `trac-$TRAC_USERNAME`. You can reset your password with the [Forgot your password?](https://gitlab.haskell.org/users/password/new) dialogue. Once you have gained access to this account you may change your username to remove the `trac-` prefix
|
|
|
|
|
|
|
|
Note GitLab usually complains that "Fast-forward merge is not possible" on your MR. If you see a green check and green "Rebase" button then there are no merge conflicts and NO action is necessary. If instead you see an exclamation mark and disabled "Merge" button, you must rebase manually and fix any merge conflicts.
|
|
|
|
If you do not have a Trac account (or would prefer to start from scratch with a new account) you can [log in](https://gitlab.haskell.org/users/auth/github) using your GitHub account or [create](https://gitlab.haskell.org/users/sign_in) a new GitLab account.
|
|
|
|
|
|
|
|
# Tickets
|
|
|
|
As a last resort, please contact @bgamari with your email address.
|
|
|
|
|
|
|
|
## Migration from Trac
|
|
|
|
## Tickets
|
|
|
|
|
|
|
|
Most of the tickets here were carried over from GHC's previous Trac installation. See the [wiki](tickets-from-trac) for details about this migration. |
|
|
\ No newline at end of file |
