zuul-jobs/roles/ensure-sphinx/tasks/main.yaml
Hervé Beraud 6fed1caf0c Allow to retrieve releasenotes requirements from a dedicated place
These changes allow to store reno reqs in a dedicated place.

Indeed some projects just want to build release notes without other
documentation.

The releasenotes playbook will use the ensure-sphinx role so I think it
make sense to allow this specific use case (no doc dir available).

Change-Id: I1d244bb47fb6b0b35df130f34007ff51047cd2f1
2021-01-07 14:00:10 +01:00

63 lines
1.9 KiB
YAML

- name: Install pip
include_role:
name: ensure-pip
- name: Install virtualenv
include_role:
name: ensure-virtualenv
# NOTE: gettext command is provided by gettext-base package,
# so we need to check a command provided by gettext package.
- name: Check for gettext installed
command: bash -c "type msgmerge"
failed_when: false
register: gettext_exists
# TODO(mordred) Make this a list of known binary depends that sphinx needs
- name: Install gettext package
package:
name: gettext
state: present
become: yes
when: gettext_exists.rc != 0
- name: Find Constraints File
include_role:
name: find-constraints
# We're not using with_first_found because the files are remote, not local.
# We want to use doc/requirements.txt or releasenotes/requirements.txt
# if it exists else we want to fallback to test-requirements.txt.
- name: Get requirements files
shell:
executable: /bin/bash
chdir: "{{ zuul_work_dir }}"
cmd: |
for f in doc/requirements.txt releasenotes/requirements.txt test-requirements.txt ; do
if [ -f $f ] ; then
echo $f
break
fi
done
register: requirements_file
- name: Gather python version variables
include_vars: "{{ sphinx_python.split('.')[0] }}.yaml"
- name: Install base doc building packages
pip:
name: "{{ doc_building_packages | union(doc_building_extra_packages) }}"
chdir: "{{ zuul_work_dir }}"
virtualenv: "{{ zuul_work_virtualenv }}"
virtualenv_python: "{{ sphinx_python }}"
extra_args: "{{ upper_constraints | default(omit) }}"
- name: Install found doc requirements
pip:
requirements: "{{ requirements_file.stdout }}"
chdir: "{{ zuul_work_dir }}"
virtualenv: "{{ zuul_work_virtualenv }}"
virtualenv_python: "{{ sphinx_python }}"
extra_args: "{{ upper_constraints | default(omit) }}"
when: requirements_file.stdout_lines