def trigger_build(project, version=None, record=True, force=False):
"""
Trigger a Build.
Helper that calls ``prepare_build`` and just effectively trigger the Celery
task to be executed by a worker.
:param project: project's documentation to be built
:param version: version of the project to be built. Default: ``latest``
:param record: whether or not record the build in a new Build object
:param force: build the HTML documentation even if the files haven't changed
:returns: Celery AsyncResult promise and Build instance
:rtype: tuple
"""
update_docs_task, build = prepare_build(
project,
version,
record,
force,
immutable=True,
)
if (update_docs_task, build) == (None, None):
# Build was skipped
return (None, None)
return (update_docs_task.apply_async(), build)
def trigger_build(project, version=None, record=True, force=False):
"""
Trigger a Build.
Helper that calls ``prepare_build`` and just effectively trigger the Celery
task to be executed by a worker.
:param project: project's documentation to be built
:param version: version of the project to be built. Default: ``latest``
:param record: whether or not record the build in a new Build object
:param force: build the HTML documentation even if the files haven't changed
:returns: Celery AsyncResult promise and Build instance
:rtype: tuple
"""
update_docs_task, build = prepare_build(
project,
version,
record,
force,
immutable=True,
)
if (update_docs_task, build) == (None, None):
# Build was skipped
return (None, None)
return (update_docs_task.apply_async(), build)
def trigger_build(project,
version=None,
commit=None,
record=True,
force=False):
"""
Trigger a Build.
Helper that calls ``prepare_build`` and just effectively trigger the Celery
task to be executed by a worker.
:param project: project's documentation to be built
:param version: version of the project to be built. Default: ``latest``
:param commit: commit sha of the version required for sending build status reports
:param record: whether or not record the build in a new Build object
:param force: build the HTML documentation even if the files haven't changed
:returns: Celery AsyncResult promise and Build instance
:rtype: tuple
"""
log.info(
'Triggering build. project=%s version=%s commit=%s',
project.slug,
version.slug if version else None,
commit,
)
update_docs_task, build = prepare_build(
project=project,
version=version,
commit=commit,
record=record,
force=force,
immutable=True,
)
if (update_docs_task, build) == (None, None):
# Build was skipped
return (None, None)
return (update_docs_task.apply_async(), build)
