Skip to content
Snippets Groups Projects
Verified Commit cee137cc authored by Pablo Correa Gomez's avatar Pablo Correa Gomez Committed by Newbyte
Browse files

README: update documentation for mrhlpr finish command (MR 44)

Fixes #17
parent 9ac0bdb7
No related branches found
No related tags found
No related merge requests found
......@@ -16,8 +16,11 @@ After installing mrhlpr (see below) and [configuring a gpg key](https://git-scm.
3. Add the MR-ID to all commit messages and sign them (`mrhlpr fixmsg`).
4. Optionally squash all commits (`git rebase -i master`).
5. Check if everything is fine (`mrhlpr status`).
6. If everything looks good force push (`git push --force`).
7. In the GitLab web UI: wait for CI, then merge.
6. Choose one of:
1. Finish things automatically following the instructions (`mrhlpr finish`). You will need to have the environment variable `GITLAB_TOKEN` set in your environment containing a [Personal Access Token](https://gitlab.com/-/user_settings/personal_access_tokens) with the "api" scope.
2. Manually push and merge:
1. If everything looks good force push (`git push --force`).
2. In the GitLab web UI: wait for CI, then merge.
## Installation
Same as for pmbootstrap: clone the repo, create a symlink to `mrhlpr.py` in your `PATH`. Optionally set up autocompletion with argcomplete. See pmbootstrap's [manual installation instructions](https://wiki.postmarketos.org/wiki/Installing_pmbootstrap#Installing_Manually) for details.
......@@ -28,7 +31,7 @@ Start with `mrhlpr checkout` and the MR-ID. The built-in checklist will tell the
```shell-session
$ cd ~/code/pmbootstrap/aports
$ mrhlpr checkout 81
$ mrhlpr checkout 81
Download https://gitlab.com/api/v4/projects/postmarketOS%2Fpmaports/merge_requests/81
Download https://gitlab.com/api/v4/projects/8065375
Checkout feature/abuild-sign-noinclude from postmarketOS/feature/abuild-sign-noinclude
......@@ -65,6 +68,8 @@ https://gitlab.com/postmarketOS/pmaports/merge_requests/81
Checklist:
* Add the MR-ID to all commits and sign them ('mrhlpr fixmsg')
* Pretty 'git log -1 --pretty'? (consider copying MR desc)
* Finish the MR: push, approve, merge, comment ('mrhlpr finish')
```
```shell-session
......@@ -82,12 +87,8 @@ https://gitlab.com/postmarketOS/pmaports/merge_requests/81
[OK ] Commits are signed
Checklist:
* Origin up-to-date? ('git fetch origin')
* Pretty 'git log'? (consider copying MR desc)
* Push your changes ('git push --force')
* Web UI: comment about your reviewing and testing
* Web UI: approve MR
* Web UI: do (automatic) merge
* Pretty 'git log -1 --pretty'? (consider copying MR desc)
* Finish the MR: push, approve, merge, comment ('mrhlpr finish')
```
### Status descriptions
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment