Changeset View
Changeset View
Standalone View
Standalone View
jobs/swh-docs.yaml
- project: | - project: | ||||
name: DDOC | name: DDOC | ||||
display-name: swh-docs | display-name: swh-docs | ||||
jobs: | jobs: | ||||
- "{name}" | - "{name}/publish" | ||||
- "{name}/dev" | |||||
- "{name}/build-on-diff" | |||||
- job-template: | |||||
- job: | name: "{name}/publish" | ||||
name: DDOC/publish | |||||
description: Build the documentation and publish it | description: Build the documentation and publish it | ||||
node: swh-sphinx | node: swh-sphinx | ||||
auth-token: ph4br1cat0r | auth-token: ph4br1cat0r | ||||
triggers: | triggers: | ||||
- timed: "@midnight" | - timed: "@midnight" | ||||
scm: | scm: | ||||
- git: | - git: | ||||
url: https://forge.softwareheritage.org/source/swh-environment.git | url: https://forge.softwareheritage.org/source/swh-environment.git | ||||
builders: | builders: | ||||
- shell: | | - shell: | | ||||
#!/bin/bash | #!/bin/bash | ||||
mr -j 4 -t update | mr -j 4 -t update | ||||
mr -j 4 -t run sh -c 'git checkout --detach `git describe --abbrev=0 --tags`; git clean -dfx' | mr -j 4 -t run sh -c 'git checkout --detach `git describe --abbrev=0 --tags`; git clean -dfx' | ||||
cd swh-docs | cd swh-docs | ||||
git checkout master | git checkout master | ||||
git clean -dfx | git clean -dfx | ||||
SPHINXOPTCOLOR='--no-color' tox -e sphinx | SPHINXOPTCOLOR='--no-color' tox -e sphinx | ||||
publishers: | publishers: | ||||
- ssh: | - ssh: | ||||
target: 'devel' | target: "devel" | ||||
site: 'pergamon' | site: "pergamon" | ||||
clean-remote: true | clean-remote: true | ||||
source: 'swh-docs/docs/_build/html/**' | source: "swh-docs/docs/_build/html/**" | ||||
remove-prefix: 'swh-docs/docs/_build/html' | remove-prefix: "swh-docs/docs/_build/html" | ||||
fail-on-error: true | fail-on-error: true | ||||
verbose: true | verbose: true | ||||
- ssh: | - ssh: | ||||
target: 'user' | target: "user" | ||||
site: 'pergamon' | site: "pergamon" | ||||
clean-remote: true | clean-remote: true | ||||
source: 'swh-docs/user/_build/html/**' | source: "swh-docs/user/_build/html/**" | ||||
remove-prefix: 'swh-docs/user/_build/html' | remove-prefix: "swh-docs/user/_build/html" | ||||
fail-on-error: true | fail-on-error: true | ||||
verbose: true | verbose: true | ||||
- ssh: | - ssh: | ||||
target: 'sysadm' | target: "sysadm" | ||||
site: 'pergamon' | site: "pergamon" | ||||
clean-remote: true | clean-remote: true | ||||
source: 'swh-docs/sysadm/_build/html/**' | source: "swh-docs/sysadm/_build/html/**" | ||||
remove-prefix: 'swh-docs/sysadm/_build/html' | remove-prefix: "swh-docs/sysadm/_build/html" | ||||
fail-on-error: true | fail-on-error: true | ||||
verbose: true | verbose: true | ||||
- job-template: | |||||
- job: | name: "{name}/dev" | ||||
name: DDOC/dev | |||||
description: Build the documentation from git repos | description: Build the documentation from git repos | ||||
node: swh-sphinx | node: swh-sphinx | ||||
auth-token: ph4br1cat0r | auth-token: ph4br1cat0r | ||||
triggers: | triggers: | ||||
- timed: "H 9-22/2 * * *" | - timed: "H 9-22/2 * * *" | ||||
scm: | scm: | ||||
Show All 10 Lines | builders: | ||||
cd swh-docs | cd swh-docs | ||||
git clean -dfx | git clean -dfx | ||||
SPHINXOPTS='-W -q --keep-going -w errors.log' SPHINXOPTCOLOR='--no-color' tox -e sphinx-dev | SPHINXOPTS='-W -q --keep-going -w errors.log' SPHINXOPTCOLOR='--no-color' tox -e sphinx-dev | ||||
publishers: | publishers: | ||||
- archive: | - archive: | ||||
artifacts: "revisions.txt,swh-docs/docs/errors.log,swh-docs/.tox/log/*" | artifacts: "revisions.txt,swh-docs/docs/errors.log,swh-docs/.tox/log/*" | ||||
- html-publisher: | - html-publisher: | ||||
name: 'SWH Documentation (HEAD)' | name: "SWH Documentation (HEAD)" | ||||
dir: 'swh-docs/docs/_build/html' | dir: "swh-docs/docs/_build/html" | ||||
files: 'index.html' | files: "index.html" | ||||
keep-all: false | keep-all: false | ||||
includes: '**/*' | includes: "**/*" | ||||
- html-publisher: | - html-publisher: | ||||
name: 'SWH User Documentation (HEAD)' | name: "SWH User Documentation (HEAD)" | ||||
dir: 'swh-docs/user/_build/html' | dir: "swh-docs/user/_build/html" | ||||
files: 'index.html' | files: "index.html" | ||||
keep-all: false | keep-all: false | ||||
includes: '**/*' | includes: "**/*" | ||||
- html-publisher: | - html-publisher: | ||||
name: 'SWH sysadmin Documentation (HEAD)' | name: "SWH sysadmin Documentation (HEAD)" | ||||
dir: 'swh-docs/sysadm/_build/html' | dir: "swh-docs/sysadm/_build/html" | ||||
files: 'index.html' | files: "index.html" | ||||
keep-all: false | keep-all: false | ||||
includes: '**/*' | includes: "**/*" | ||||
- job-template: | |||||
name: "{name}/build-on-diff" | |||||
display_name: Phab. diff | |||||
project-type: pipeline | |||||
docker_image: sphinx | |||||
concurrent: true | |||||
sandbox: true | |||||
auth-token: "ph4br1cat0r" | |||||
properties: | |||||
- build-discarder: | |||||
artifact-num-to-keep: 20 | |||||
parameters: | |||||
- git-parameter: | |||||
name: REVISION | |||||
type: PT_REVISION | |||||
defaultValue: master | |||||
description: Git revision to build. | |||||
- string: | |||||
name: PHID | |||||
description: PHID of the Phabricator target object on which results will be reported. | |||||
- string: | |||||
name: DIFF_ID | |||||
description: ID of the Diff patch to apply, if any | |||||
- string: | |||||
name: REV_ID | |||||
description: ID of the Phabricator revision, if any | |||||
- string: | |||||
name: STAGING_URI | |||||
description: URI of the staging repository | |||||
dsl: !include-jinja2: templates/swh-docs-pipeline-diff.groovy.j2 |