Project

General

Profile

Edit History

Development Resources ยป

PrProcessor » History » Version 1

Dominic Cleal, 10/29/2015 11:16 AM
document integration points

1 1 Dominic Cleal 
h1. PR Processor
2 





    3
    
    
    
prprocessor is a web service hosted on the project's OpenShift account, which receives GitHub webhooks/notifications and helps sync PRs to Redmine and Jenkins.





    4
    
    
    





    5
    
    
    
It's a simple Sinatra app, and the source is available here: https://github.com/theforeman/prprocessor.





    6
    
    
    





    7
    
    
    
h2. OpenShift





    8
    
    
    





    9
    
    
    
It runs on OpenShift using a group account, to which a few developers have push access to.  When merging into the GitHub repository, please keep this in sync with OpenShift's repo by pushing to both.





    10
    
    
    





    11
    
    
    
h2. GitHub integration





    12
    
    
    





    13
    
    
    
It receives requests from GitHub when pull requests are opened or synchronized (updated).  These contain lots of info about the PR, including the author, branches etc.  A repository admin needs to add the webhook to send these events - more information on the "Jenkins":http://projects.theforeman.org/projects/foreman/wiki/Jenkins#PR-scanner-repo-hooks wiki page.





    14
    
    
    





    15
    
    
    
It performs checks on the PR to ensure it meets our usual standards.





    16
    
    
    





    17
    
    
    
h3. Commit message styles





    18
    
    
    





    19
    
    
    
For repositories in the "redmine_issue_required_repos.yaml":https://github.com/theforeman/prprocessor/blob/master/config/redmine_issue_required_repos.yaml list, it enforces that:





    20
    
    
    





    21
    
    
    
# Commit messages match the style in [[Reviewing_patches-commit_message_format]]





    22
    
    
    
# A Redmine ticket is referenced in the commit message





    23
    
    
    





    24
    
    
    
h3. PR is mergeable





    25
    
    
    





    26
    
    
    
It checks whether the PR is mergeable against the branch it's proposed for.  This will only pick up this error when the PR is updated because the service is event-driven, so it won't notify authors when a PR goes out of sync due to master/develop being changed, and the PR is not updated.





    27
    
    
    





    28
    
    
    
h2. Redmine integration





    29
    
    
    





    30
    
    
    
When it receives an event, the corresponding Redmine ticket is updated to link it to the pull request.  The script updates these fields:





    31
    
    
    





    32
    
    
    
# _Status_ is changed to _Ready for Testing_





    33
    
    
    
# _Assigned To_ is changed to the PR author - update "users.yaml":https://github.com/theforeman/prprocessor/blob/master/config/users.yaml for new or unknown developers





    34
    
    
    
# _Target version_ (usually sprints) is set to the latest available version





    35
    
    
    
# _Pull request_ is set to the URL of the PR





    36
    
    
    





    37
    
    
    
h2. Jenkins integration





    38
    
    
    





    39
    
    
    
A "PR scanner" job runs regularly on Jenkins and is responsible for all checking, testing and updating of pull requests.  Since it uses a lot of API queries, it only runs every 30 minutes.  More about this job is on the "Jenkins wiki page":http://projects.theforeman.org/projects/foreman/wiki/Jenkins#PR-scanner.





    40
    
    
    





    41
    
    
    
To get faster PR testing, when a PR hook is received by the prprocessor, it triggers an immediate run/build of the Jenkins scanner job against the relevant PR.  No further action is taken by the prprocessor.