This repository holds two programs, mrhlpr and mrtest. The mrhlpr program is described below, information about mrtest can be found in the postmarketOS wiki.
The mrtest program must be run on pmOS or alpine device in order to work correctly.
mrhlpr - merge request helper
Lightweight script to support maintainers of postmarketOS in the merge workflow on GitLab.
After installing mrhlpr (see below) and configuring a gpg key to use with git, this is the basic workflow. Further below is a full example session with example output.
- Use
cdto enter a locally cloned git repository (e.g.pmaports.git). - Checkout the merge request locally (
mrhlpr checkout 123). - Rebase on latest master (
git rebase master). - Add the MR-ID to all commit messages and sign them (
mrhlpr fixmsg). - Optionally squash all commits (
git rebase -i master). - Check if everything is fine (
mrhlpr status). - Choose one of:
- Finish things automatically following the instructions (
mrhlpr finish). You will need to have the environment variableGITLAB_TOKENset in your environment containing a Personal Access Token with the "api" scope. - Manually push and merge:
- If everything looks good force push (
git push --force). - In the GitLab web UI: wait for CI, then merge.
- If everything looks good force push (
- Finish things automatically following the instructions (
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 for details.
Example Session
Start with mrhlpr checkout and the MR-ID. The built-in checklist will tell the next steps. All API requests get cached on disk.
$ cd ~/code/pmbootstrap/aports
$ mrhlpr checkout 81
Download https://gitlab.postmarketos.org/api/v4/projects/postmarketOS%2Fpmaports/merge_requests/81
Download https://gitlab.postmarketos.org/api/v4/projects/8065375
Checkout feature/abuild-sign-noinclude from postmarketOS/feature/abuild-sign-noinclude
https://gitlab.postmarketos.org/postmarketOS/pmaports/merge_requests/81
"main/abuild-sign-noinclude: new aport" (!81)
10 commits from postmarketOS/feature/abuild-sign-noinclude
[OK ] Changes allowed
[OK ] Clean worktree
[NOK] Rebase on master
[NOK] MR-ID in commit msgs
[NOK] Commits are signed
Checklist:
* 10 commits: consider squashing ('git rebase -i origin/master')
* Rebase on master ('git rebase origin/master')
* Check again ('mrhlpr status')$ git rebase -i master
$ mrhlpr status
https://gitlab.postmarketos.org/postmarketOS/pmaports/merge_requests/81
"main/abuild-sign-noinclude: new aport" (!81)
1 commit from postmarketOS/feature/abuild-sign-noinclude
[OK ] Changes allowed
[OK ] Clean worktree
[OK ] Rebase on master
[NOK] MR-ID in commit msgs
[NOK] Commits are signed
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')$ mrhlpr fixmsg
Appending ' (!81)' to all commits...
https://gitlab.postmarketos.org/postmarketOS/pmaports/merge_requests/81
"main/abuild-sign-noinclude: new aport" (!81)
1 commit from postmarketOS/feature/abuild-sign-noinclude
[OK ] Changes allowed
[OK ] Clean worktree
[OK ] Rebase on master
[OK ] MR-ID in commit msgs
[OK ] Commits are signed
Checklist:
* Pretty 'git log -1 --pretty'? (consider copying MR desc)
* Finish the MR: push, approve, merge, comment ('mrhlpr finish')Status descriptions
| Status | Description |
|---|---|
| [OK ] | Everything is OK |
| [NOK] | Something is wrong |
| [???] | Seems OK, but manually check |
mrhlpr.json
Optionally you can add a .mrhlpr.json file to your respository, this contains extra verification rules specific to your repository. An example file:
{
"subject_format": {
"pass": [
"^[a-z]+/[a-z-0-9*{}]+: new aport(s|)( \\(!\\d+\\)|)$",
"^[a-z]+/[a-z-0-9*{}]+: pkgrel bump( \\(!\\d+\\)|)$",
"^[a-z-0-9*{}]+: new device \\([^\\)]+\\)( \\(!\\d+\\)|)",
"^[a-z]+/[a-z-0-9*{}]+: upgrade to [0-9\\.a-z\\-_]+( \\(!\\d+\\)|)$"
],
"unknown": [
"^[a-z-0-9*{}\\/]+: [a-z\\-0-9*{}\\(\\)\\._ ]+( \\(!\\d+\\)|)$"
]
}
}Portability
This script is not postmarketOS specific, it should work with any GitLab repository. Right now, only gitlab.postmarketos.org is detected - but detecting any GitLab servers could be added in mrhlpr/gitlab.py:parse_git_origin() if desired.
Troubleshooting
mrhlpr -v displays debug log messages, such as all git commands and their output, as well as the locations of all http cache files.