~jenkaas-hackers/jenkins-launchpad-plugin/trunk

« back to all changes in this revision

Viewing changes to README

  • Committer: Paride Legovini
  • Date: 2019-06-25 13:31:52 UTC
  • Revision ID: paride.legovini@canonical.com-20190625133152-cajl03kwdd0xorjz
Repository converted to git

https://code.launchpad.net/jenkins-launchpad-plugin/+git

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
After installing this package you need to:
2
 
 
3
 
cp /usr/share/doc/jlp/jlp.config ~/.jlp/jlp.config
4
 
 
5
 
And then edit the options in your local copy.
6
 
 
7
 
 
8
 
See also /usr/share/doc/jenkins-launchpad-plugin/html/index.html for 
9
 
more info.
10
 
 
11
 
# TEMPLATING
12
 
 
13
 
Jenkins Launchpad Plugin commands voteOnMergeProposal and autoland both
14
 
support using custom templates for the messages sent to launchpad.  The 
15
 
message templates imported using jinja2.  See http://jinja.pocoo.org/docs/2.10/templates/
16
 
for more information.
17
 
 
18
 
When using custom templating, the user only needs to update the 
19
 
templates with messages they wish to change; the defaults will be
20
 
used in all other cases.
21
 
 
22
 
When working with custom templates, it's recommended that the user starts with
23
 
a default template and makes the changes they wish to see.
24
 
 
25
 
## Arguments
26
 
 
27
 
The arguments are loaded into a dictionary called "args" so all calls need
28
 
to be prefixed with "args."
29
 
 
30
 
`result` defines the result from the tests, usually passed in as an argument
31
 
to the script, "PASSED" or "FAILED"
32
 
`revision` defines the git or bzr revision being reviewed.
33
 
`build_url` defines the URL for the build being run. it can be used to generate
34
 
the rebuild URL.
35
 
`merge_url` defines the URL to the merge request being reviewed.
36
 
`coverity_artifacts` defines artifcats built during tests run for this revision.
37
 
It is either None or a list of artificats.
38
 
`executed_tests` defines tests run against this propsal.  It is a list of
39
 
dictionaries, where each dictionary defines 3 values:
40
 
    `deb` defines list of jenkins urls for debs generated from the test.
41
 
    `output` defines the jenkins url for the executed test.
42
 
    `result` defines the result of that particular build job reported by jenkins.