Skip to content

Commit 9d444f0

Browse files
toli-yGoogle-ML-Automation
authored andcommitted
[documentaiton] Add README.md with description of github actions ci infra.
PiperOrigin-RevId: 736943380
1 parent 36a28ca commit 9d444f0

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

build_tools/ci/readme.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
This folder contains scripts and commands executed by GitHub actions in OpenXLA,
2+
TensorFlow and JAX OSS repos. The GitHub actions replaced
3+
KokoroPresubmit-tensorflow* workflows. They run under
4+
`Copybara_XLA{Presubmit,Submit}` presubmit chip (category) at Google internally.
5+
The tests run on several target OS configurations/GCP containers such as Linux
6+
x86 with GPU or Linux ARM64. They assure that XLA/Tensor Flow/JAX compiles and
7+
runs on those platforms. The tests uses released OSS c++ clang compiler which
8+
has some differences in supporting c++ standards compared Google's internal
9+
version.
10+
11+
#### How it works
12+
13+
Repo specific GitHub actions call `build.py --build="build_name"`. E.g. OpenXLA
14+
uses https://github.com/openxla/xla/blob/main/.github/workflows/ci.yml
15+
16+
The build here is a set of shell script commands executing the test targets or
17+
doing compile only testing. Each GitHub action call translates into compile only
18+
test:
19+
20+
1. dryrun `bazel build --nobuild ... test_targets`
21+
1. actual compile `bazel build ... test_targets`
22+
1. analyse results `bazel analyze-profile ...`
23+
24+
or compile and run test commands:
25+
26+
1. dry run `bazel build --nobuild ... test_targets`
27+
1. actual test `bazel test ... test_targets`
28+
1. analyse results `bazel analyze-profile profile.json.gz`
29+
30+
Checking in changes to `build.py` regenerates `golden_commands.txt` which lets
31+
us see how commands are changing. `golden_commands.txt` are not called as part
32+
of the continuous integration process.
33+
34+
#### When does it run?
35+
36+
The GitHub actions are automatically called as part of Google presubmit. The
37+
GitHub actions are automatically called on GitHub PR commit if the committer is
38+
part of OpenXLA GitHub org. Committer which are not part of OpenXLA org need an
39+
approval from OpenXLA org member to run the actions.

0 commit comments

Comments
 (0)