octomachinery.app.action.config module

GitHub Action environment and metadata representation.

class octomachinery.app.action.config.GitHubActionConfig(workflow=None, action=None, actor=None, repository=None, event_name=None, event_path=None, workspace=None, sha=None, ref=None, token=None)

Bases: object

GitHub Action config.

action

actor

event_name

event_path

classmethod from_environ(environ=environ({'READTHEDOCS_VIRTUALENV_PATH': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/envs/latest', 'READTHEDOCS_CANONICAL_URL': 'https://docs.octomachinery.dev/en/latest/', 'READTHEDOCS_GIT_CLONE_URL': 'https://github.com/sanitizers/octomachinery.git', 'HOME': '/home/docs', 'NO_COLOR': '1', 'READTHEDOCS': 'True', 'READTHEDOCS_PRODUCTION_DOMAIN': 'app.readthedocs.org', 'READTHEDOCS_REPOSITORY_PATH': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest', 'READTHEDOCS_PROJECT': 'octomachinery', 'READTHEDOCS_OUTPUT': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest/_readthedocs/', 'READTHEDOCS_VERSION_TYPE': 'branch', 'LANG': 'C.UTF-8', 'READTHEDOCS_LANGUAGE': 'en', 'READTHEDOCS_GIT_COMMIT_HASH': 'c69244151c23ef9228db745559763658c207ccc3', 'READTHEDOCS_VERSION_NAME': 'latest', 'READTHEDOCS_VERSION': 'latest', 'READTHEDOCS_GIT_IDENTIFIER': 'master', 'PATH': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest/.tox/build-docs/bin:/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/envs/latest/bin:/home/docs/.asdf/shims:/home/docs/.asdf/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', 'PYTHONHASHSEED': '1596472266', 'PIP_DISABLE_PIP_VERSION_CHECK': '1', 'PYTHONIOENCODING': 'utf-8', 'TOX_ENV_NAME': 'build-docs', 'TOX_WORK_DIR': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest/.tox', 'TOX_ENV_DIR': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest/.tox/build-docs', 'VIRTUAL_ENV': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest/.tox/build-docs', 'PIP_USER': '0', 'DOCUTILSCONFIG': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest/docs/docutils.conf'}))

classmethod generate_help(**kwargs)

ref

repository

sha

token

workflow

workspace