hooks.set_request_template

hooks.set_request_template(path_organisational_framework_request_template: Union[pathlib.Path, str], dir_govcookiecutter: Union[pathlib.Path, str], repository_hosting_platform: str) None

Set a pull or merge request template in the outputted project structure for a specific organisation.

A pull request template is created if the user chooses GitHub as their repository hosting platform. A merge request template is created if they choose GitLab instead.

Parameters
  • path_organisational_framework_request_template – A file path to the specific organisation pull or merge request template.

  • dir_govcookiecutter – A folder path to the outputted govcookiecutter template.

  • repository_hosting_platform – The repository hosting platform. Must be one of “GitHub” or “GitLab” (case insensitive).

Returns

A organisation-specific pull or merge request template in the correct location, depending on their choice of GitHub or GitLab as the repository hosting platform. If neither GitHub or GitLab are chosen, a ValueError is raised.