Automatic Header Generation Service#

Purpose#

The service header-service generates a table with review and approver informations. It uses the template header.need to generate this table.

This modules can use two different methods to extract the needed information.

The used method can be configured as a configuration parameter in conf.py.

header_service_use_github_data = True

GitHub data is used if parameter is not set.

This module uses the following environment variables if the extraction method Github data is configured:

GH_TOKEN: Github access token GITHUB_REF_NAME: Github reference name (/merge) GITHUB_REPOSITORY: Github repository /

The document generation has to be executed as follows:

GH_TOKEN=$GH_TOKEN bazel run //:docs

Sphinx cannot access the environment variables when started via Bazel build.

If extraction method Merge commit info is used the document generation can be executed as follows:

bazel run //:docs

Add the descriptor header_service to a RST file to fill out review and approver informations.

.. needservice:: header-service

This generates the following Table: