Merge "Add lint to releng repo"
[releng.git] / docs / jenkins-job-builder / opnfv-jjb-usage.rst
index aabfda7..fc968f8 100644 (file)
+===========================================
 Creating/Configuring/Verifying Jenkins Jobs
-============================================
+===========================================
 
-Clone the repo::
+Clone and setup the repo::
 
- git clone ssh://YOU@gerrit.opnfv.org:29418/releng
+    git clone ssh://YOU@gerrit.opnfv.org:29418/releng
+    cd releng
+    git review -s
 
-make changes::
+Make changes::
 
- git commit -sv
- git review
- remote: Resolving deltas: 100% (3/3)
- remote: Processing changes: new: 1, refs: 1, done
- remote:
- remote: New Changes:
- remote:   https://gerrit.opnfv.org/gerrit/51
- remote:
- To ssh://agardner@gerrit.opnfv.org:29418/releng.git
-  * [new branch]      HEAD -> refs/publish/master
   git commit -sv
   git review
   remote: Resolving deltas: 100% (3/3)
   remote: Processing changes: new: 1, refs: 1, done
   remote:
   remote: New Changes:
   remote:   https://gerrit.opnfv.org/gerrit/51
   remote:
   To ssh://agardner@gerrit.opnfv.org:29418/releng.git
+     * [new branch]      HEAD -> refs/publish/master
 
-Follow the link to gerrit https://gerrit.opnfv.org/gerrit/51 in a few moments the verify job will have completed and you will see Verified +1 jenkins-ci in the gerrit ui.
+Follow the link to gerrit https://gerrit.opnfv.org/gerrit/51 in a few moments
+the verify job will have completed and you will see Verified +1 jenkins-ci in
+the gerrit ui.
 
-If the changes pass the verify job https://build.opnfv.org/ci/view/builder/job/builder-verify-jjb/ The patch can be submitited by a committer.
+If the changes pass the verify job
+https://build.opnfv.org/ci/view/builder/job/builder-verify-jjb/ ,
+the patch can be submitited by a committer.
 
 Job Types
 
 * Verify Job
 
- * Trigger: **recheck** or **reverify**
 * Trigger: **recheck** or **reverify**
 
 * Merge Job
 
- * Trigger: **remerge**
 * Trigger: **remerge**
 
-The verify and merge jobs are retriggerable in Gerrit by simply leaving a comment with one of the keywords listed above. This is useful in case you need to re-run one of those jobs in case if build issues or something changed with the environment.
+* Experimental Job
 
-You can add below persons as reviewers to your patch in order to get it reviewed and submitted.
+  * Trigger: **check-experimental**
 
-* Ulrich Kleber (Ulrich.Kleber@huawei.com)
-* Fatih Degirmenci (fatih.degirmenci@ericsson.com)
-* Xinyu Zhao(Jerry) (zhaoxinyu@huawei.com)
+The verify and merge jobs are retriggerable in Gerrit by simply leaving
+a comment with one of the keywords listed above.
+This is useful in case you need to re-run one of those jobs in case
+if build issues or something changed with the environment.
+
+The experimental jobs are not triggered automatically. You need to leave
+a comment with the keyword list above to trigger it manually. It is useful
+for trying out experimental features.
+
+Note that, experimental jobs `skip vote`_ for verified status, which means
+it will reset the verified status to 0. If you want to keep the verified
+status, use **recheck-experimental** in commit message to trigger both
+verify and experimental jobs.
+
+You can add below persons as reviewers to your patch in order to get it
+reviewed and submitted.
+
+* fatih.degirmenci@ericsson.com
+* agardner@linuxfoundation.org
+* trozet@redhat.com
+* morgan.richomme@orange.com
+* vlaza@cloudbasesolutions.com
+* matthew.lijun@huawei.com
+* meimei@huawei.com
+* jose.lausuch@ericsson.com
+* koffirodrigue@gmail.com
+* r-mibu@cq.jp.nec.com
+
+Or Add the group releng-contributors
 
 Or just email a request for submission to opnfv-helpdesk@rt.linuxfoundation.org
 
-The Current merge and verify jobs for jenkins job builder as pulled from the repo::
-
- - project:
-    name: builder-jobs
-    jobs:
-        - 'builder-verify-jjb'
-        - 'builder-merge'
-
-    project: 'releng'
-
- - job-template:
-    name: builder-verify-jjb
-
-    project-type: freestyle
-
-    logrotate:
-        daysToKeep: 30
-        numToKeep: 10
-        artifactDaysToKeep: -1
-        artifactNumToKeep: -1
-
-    parameters:
-        - project-parameter:
-            project: '{project}'
-        - gerrit-parameter:
-            branch: 'master'
-    scm:
-        - gerrit-trigger-scm:
-            credentials-id: '{ssh-credentials}'
-            refspec: '$GERRIT_REFSPEC'
-            choosing-strategy: 'gerrit'
-
-    wrappers:
-        - ssh-agent-credentials:
-            user: '{ssh-credentials}'
-
-    triggers:
-        - gerrit:
-            trigger-on:
-                - patchset-created-event:
-                    exclude-drafts: 'false'
-                    exclude-trivial-rebase: 'false'
-                    exclude-no-code-change: 'false'
-                - draft-published-event
-                - comment-added-contains-event:
-                    comment-contains-value: 'recheck'
-                - comment-added-contains-event:
-                    comment-contains-value: 'reverify'
-            projects:
-              - project-compare-type: 'ANT'
-                project-pattern: 'releng'
-                branches:
-                  - branch-compare-type: 'ANT'
-                    branch-pattern: '**/master'
-                file-paths:
-                    - compare-type: ANT
-                      pattern: jjb/**
-                    - compare-type: ANT
-                      pattern: jjb-templates/**
-
-
-    builders:
-        - shell: |
-            source /opt/virtualenv/jenkins-job-builder/bin/activate
-            jenkins-jobs test /opt/jenkins-ci/builder/
-
- - job-template:
-    name: 'builder-merge'
-
-    # builder-merge job to run JJB update
-    #
-    # This job's purpose is to update all the JJB
-
-    project-type: freestyle
-
-    logrotate:
-        daysToKeep: 30
-        numToKeep: 40
-        artifactDaysToKeep: -1
-        artifactNumToKeep: 5
-
-    parameters:
-        - project-parameter:
-            project: '{project}'
-        - gerrit-parameter:
-            branch: 'master'
-
-    scm:
-        - gerrit-trigger-scm:
-            credentials-id: '{ssh-credentials}'
-            refspec: ''
-            choosing-strategy: 'default'
-
-    wrappers:
-        - ssh-agent-credentials:
-            user: '{ssh-credentials}'
-
-    triggers:
-        - gerrit:
-            trigger-on:
-                - change-merged-event
-                - comment-added-contains-event:
-                    comment-contains-value: 'remerge'
-            projects:
-              - project-compare-type: 'ANT'
-                project-pattern: 'releng'
-                branches:
-                    - branch-compare-type: 'ANT'
-                      branch-pattern: '**/master'
-                file-paths:
-                    - compare-type: ANT
-                      pattern: jjb/**
-
-    builders:
-        - shell: |
-                source /opt/virtualenv/jenkins-job-builder/bin/activate
-                cd /opt/jenkins-ci/releng
-                git pull
-                jenkins-jobs update --delete-old jjb/
-
-
-
-**Documentation tracking**
-
-Revision: _sha1_
-
-Build date:  _date_
+The Current merge and verify jobs for jenkins job builder can be found
+in `releng-jobs.yaml`_.
+
+.. _releng-jobs.yaml:
+    https://gerrit.opnfv.org/gerrit/gitweb?p=releng.git;a=blob;f=jjb/releng-jobs.yaml;
+.. _skip vote:
+    https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger#GerritTrigger-SkipVote
\ No newline at end of file