blob: e982ca33d01438ed17b8e5b1a535175981fab652 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
MYPY = False
if MYPY:
# MYPY is set to True when run under Mypy.
from typing import Optional, Text
class GitHubChecksOutputter:
"""Provides a method to output data to be shown in the GitHub Checks UI.
This can be useful to provide a summary of a given check (e.g. the lint)
to enable developers to quickly understand what has gone wrong. The output
supports markdown format.
https://docs.taskcluster.net/docs/reference/integrations/github/checks#custom-text-output-in-checks
"""
def __init__(self, path):
# type: (Text) -> None
self.path = path
def output(self, line):
# type: (Text) -> None
with open(self.path, mode="a") as f:
f.write(line)
f.write("\n")
__outputter = None
def get_gh_checks_outputter(filepath):
# type: (Optional[Text]) -> Optional[GitHubChecksOutputter]
"""Return the outputter for GitHub Checks output, if enabled.
:param filepath: The filepath to write GitHub Check output information to,
or None if not enabled.
"""
global __outputter
if filepath and __outputter is None:
__outputter = GitHubChecksOutputter(filepath)
return __outputter
|
