Skip to content

gh_workflow_single

TemplateVars

Bases: BaseModel

Template variables.

Attributes:

Name Type Description
m_dir str

...
ci_dir str

...
default_runner str

...
container str

...
global_env str

...
docker_login str

...
build_steps str

...
extra_inputs str

...
Source code in m/ci/docker/gh_workflow_single.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
class TemplateVars(BaseModel):
    """Template variables."""

    m_dir: str

    ci_dir: str

    default_runner: str

    container: str

    global_env: str

    docker_login: str

    build_steps: str

    extra_inputs: str

Workflow

Bases: BaseModel

Helper class to write the m workflow.

Attributes:

Name Type Description
m_dir str

...
ci_dir str

...
global_env dict[str, str] | None

...
default_runner str

...
docker_registry str

...
extra_build_steps list[dict[str, Any]] | None

...
extra_inputs dict[str, GithubWorkflowInput] | None

...
container dict[str, Any] | None

...
images list[DockerImage]

...
Source code in m/ci/docker/gh_workflow_single.py 
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
class Workflow(BaseModel):
    """Helper class to write the `m` workflow."""

    m_dir: str

    ci_dir: str

    global_env: dict[str, str] | None

    default_runner: str

    docker_registry: str

    extra_build_steps: list[dict[str, Any]] | None

    extra_inputs: dict[str, GithubWorkflowInput] | None

    container: dict[str, Any] | None

    images: list[DockerImage]

    def docker_login_str(self: 'Workflow') -> str:
        """Generate a github action str to login to docker.

        Returns:
            A string to add to the Github workflow.
        """
        login_obj = """\
            name: docker-login
            uses: docker/login-action@v3
            with:
              registry: ghcr.io
              username: ${{ github.actor }}
              password: ${{ secrets.GITHUB_TOKEN }}"""
        return _indent(dedent(login_obj), 4)

    def global_env_str(self: 'Workflow') -> str:
        """Generate a github action str with the global environment variables.

        Returns:
            A string to add to the Github workflow.
        """
        all_vars = {
            'GITHUB_TOKEN': '${{ secrets.GITHUB_TOKEN }}',
            'M_TAG': '${{ inputs.m-tag }}',
            'M_CACHE_FROM_PR': '${{ inputs.cache-from-pr }}',
            **(self.global_env or {}),
        }
        vars_str = '\n'.join([
            f'  {env_var}: {env_val}'
            for env_var, env_val in all_vars.items()
        ])
        return f'\n{vars_str}'

    def extra_inputs_str(self: 'Workflow') -> str:
        """Generate a github action str with the extra inputs.

        Returns:
            A string to add to the Github workflow.
        """
        if not self.extra_inputs:
            return ''
        lines: list[str] = []
        extras = {
            key: input_inst.model_dump()
            for key, input_inst in self.extra_inputs.items()
        }
        inputs_str = _indent(yaml.dumps(extras), 3)
        lines.append(f'\n      {inputs_str}')
        return '\n'.join(lines).rstrip()

    def container_str(self: 'Workflow') -> str:
        """Generate a string specifying a container to run on.

        Returns:
            A string to add to the Github workflow.
        """
        if not self.container:
            return '\n'.join([
                '',
                '    env:',
                '      ARCH: ${{ matrix.arch }}',
            ])
        lines: list[str] = ['\n    container:']
        content_str = _indent(yaml.dumps(self.container), 3)
        lines.append(f'      {content_str}')
        return '\n'.join(lines).rstrip()

    def build_steps_str(self: 'Workflow') -> str:
        """Generate a github action str for the build steps.

        Returns:
            A string to add to the Github workflow.
        """
        lines: list[str] = []
        for step in self.extra_build_steps or []:
            step_str = _indent(yaml.dumps(step)[:-1], 1)
            lines.append(f'- {step_str}')
        for img in self.images:
            cache_sh = f'{self.ci_dir}/_find-cache.sh'
            build_sh = f'{self.ci_dir}/{img.image_name}.build.sh'
            push_sh = f'{self.ci_dir}/_push-image.sh'
            image_steps = [
                f'- name: {img.image_name} - cache',
                f'  run: {cache_sh} {img.image_name}',
                f'- name: {img.image_name} - build',
                f'  run: {build_sh}',
                f'- name: {img.image_name} - push',
                f'  run: {push_sh} {img.image_name}',
            ]
            lines.extend(image_steps)
        return _indent('\n'.join(lines), 3)

    def __str__(self: 'Workflow') -> str:
        """Stringify the workflow file.

        Returns:
            The github workflow.
        """
        template_vars = TemplateVars(
            m_dir=self.m_dir,
            default_runner=self.default_runner,
            global_env=self.global_env_str(),
            ci_dir=self.ci_dir,
            docker_login=self.docker_login_str(),
            build_steps=self.build_steps_str(),
            extra_inputs=self.extra_inputs_str(),
            container=self.container_str(),
        )
        return TEMPLATE.format(**template_vars.model_dump())

__str__()

Stringify the workflow file.

Returns:

Type Description
str

The github workflow.
Source code in m/ci/docker/gh_workflow_single.py 
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
def __str__(self: 'Workflow') -> str:
    """Stringify the workflow file.

    Returns:
        The github workflow.
    """
    template_vars = TemplateVars(
        m_dir=self.m_dir,
        default_runner=self.default_runner,
        global_env=self.global_env_str(),
        ci_dir=self.ci_dir,
        docker_login=self.docker_login_str(),
        build_steps=self.build_steps_str(),
        extra_inputs=self.extra_inputs_str(),
        container=self.container_str(),
    )
    return TEMPLATE.format(**template_vars.model_dump())

build_steps_str()

Generate a github action str for the build steps.

Returns:

Type Description
str

A string to add to the Github workflow.
Source code in m/ci/docker/gh_workflow_single.py 
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
def build_steps_str(self: 'Workflow') -> str:
    """Generate a github action str for the build steps.

    Returns:
        A string to add to the Github workflow.
    """
    lines: list[str] = []
    for step in self.extra_build_steps or []:
        step_str = _indent(yaml.dumps(step)[:-1], 1)
        lines.append(f'- {step_str}')
    for img in self.images:
        cache_sh = f'{self.ci_dir}/_find-cache.sh'
        build_sh = f'{self.ci_dir}/{img.image_name}.build.sh'
        push_sh = f'{self.ci_dir}/_push-image.sh'
        image_steps = [
            f'- name: {img.image_name} - cache',
            f'  run: {cache_sh} {img.image_name}',
            f'- name: {img.image_name} - build',
            f'  run: {build_sh}',
            f'- name: {img.image_name} - push',
            f'  run: {push_sh} {img.image_name}',
        ]
        lines.extend(image_steps)
    return _indent('\n'.join(lines), 3)

container_str()

Generate a string specifying a container to run on.

Returns:

Type Description
str

A string to add to the Github workflow.
Source code in m/ci/docker/gh_workflow_single.py 
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
def container_str(self: 'Workflow') -> str:
    """Generate a string specifying a container to run on.

    Returns:
        A string to add to the Github workflow.
    """
    if not self.container:
        return '\n'.join([
            '',
            '    env:',
            '      ARCH: ${{ matrix.arch }}',
        ])
    lines: list[str] = ['\n    container:']
    content_str = _indent(yaml.dumps(self.container), 3)
    lines.append(f'      {content_str}')
    return '\n'.join(lines).rstrip()

docker_login_str()

Generate a github action str to login to docker.

Returns:

Type Description
str

A string to add to the Github workflow.
Source code in m/ci/docker/gh_workflow_single.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
def docker_login_str(self: 'Workflow') -> str:
    """Generate a github action str to login to docker.

    Returns:
        A string to add to the Github workflow.
    """
    login_obj = """\
        name: docker-login
        uses: docker/login-action@v3
        with:
          registry: ghcr.io
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}"""
    return _indent(dedent(login_obj), 4)

extra_inputs_str()

Generate a github action str with the extra inputs.

Returns:

Type Description
str

A string to add to the Github workflow.
Source code in m/ci/docker/gh_workflow_single.py 
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
def extra_inputs_str(self: 'Workflow') -> str:
    """Generate a github action str with the extra inputs.

    Returns:
        A string to add to the Github workflow.
    """
    if not self.extra_inputs:
        return ''
    lines: list[str] = []
    extras = {
        key: input_inst.model_dump()
        for key, input_inst in self.extra_inputs.items()
    }
    inputs_str = _indent(yaml.dumps(extras), 3)
    lines.append(f'\n      {inputs_str}')
    return '\n'.join(lines).rstrip()

global_env_str()

Generate a github action str with the global environment variables.

Returns:

Type Description
str

A string to add to the Github workflow.
Source code in m/ci/docker/gh_workflow_single.py 
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def global_env_str(self: 'Workflow') -> str:
    """Generate a github action str with the global environment variables.

    Returns:
        A string to add to the Github workflow.
    """
    all_vars = {
        'GITHUB_TOKEN': '${{ secrets.GITHUB_TOKEN }}',
        'M_TAG': '${{ inputs.m-tag }}',
        'M_CACHE_FROM_PR': '${{ inputs.cache-from-pr }}',
        **(self.global_env or {}),
    }
    vars_str = '\n'.join([
        f'  {env_var}: {env_val}'
        for env_var, env_val in all_vars.items()
    ])
    return f'\n{vars_str}'