ReadTheDocs Jobs¶
Job Groups¶
Job groups are a great tool to configure categories of jobs together at the same time. Below the example are some starting point job-groups but we recommend creating your own to ensure that the jobs configured reflect the project’s needs.
An example project:
- job-group:
name: odl-maven-jobs
jobs:
- gerrit-maven-clm
- gerrit-maven-merge
- gerrit-maven-release
- gerrit-maven-verify
- gerrit-maven-verify-dependencies:
build-timeout: 180
mvn-version: mvn35
- project:
name: aaa
jobs:
- odl-maven-jobs
In this example we are using the job-group to assign a list of common jobs to
the aaa project. The job-group also hardcodes mvn-version
to mvn35 and
build-timeout
to 180 for all projects using this job-group.
A benefit of this method is for example disabling entire category of jobs by
modifying the job-group, insert disable-job: true
parameter
against the jobs to disable.
Below is a list of Maven job groups:
---
- job-group:
name: '{project-name}-rtd-jobs'
jobs:
- gerrit-rtd-merge
- gerrit-rtd-verify
- job-group:
name: '{project-name}-github-rtd-jobs'
jobs:
- github-rtd-merge
- github-rtd-verify
Macros¶
lf-rtd-common¶
RTD verify and merge jobs are the same except for their scm, trigger, and builders definition. This anchor is the common template.
Job Templates¶
ReadTheDocs Merge¶
Merge job which triggers a POST of the docs project to readthedocs.
To use this job first configure the Generic API incoming webhook
in
ReadTheDocs. To do that follow these steps:
Browse to https://readthedocs.org/dashboard/PROJECT/integrations/
Click on
Generic API incoming webhook
Note
If not available click on
Add integration
and add theGeneric API incoming webhook
.Copy the custom webhook URL, this is your
rtd-build-url
For example: https://readthedocs.org/api/v2/webhook/opendaylight/32321/
Copy the token, this is your
rtd-token
Template Names: |
|
||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Comment Trigger: | |||||||||||||||||||||||||||||||||||||
remerge |
|||||||||||||||||||||||||||||||||||||
Required parameters: | |||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
Optional parameters: | |||||||||||||||||||||||||||||||||||||
|
ReadTheDocs Verify¶
Verify job which runs a tox build of the docs project
Template Names: |
|
||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Comment Trigger: | |||||||||||||||||||||||||||||||||||||||||||||
recheck|reverify |
|||||||||||||||||||||||||||||||||||||||||||||
Required Parameters: | |||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters: | |||||||||||||||||||||||||||||||||||||||||||||
|