Skip to content

Commit 1d4413d

Browse files
authored
Update project root documentations reflecting Jenkins shutdown (apache#30130)
1 parent 4981c0c commit 1d4413d

File tree

2 files changed

+24
-16
lines changed

2 files changed

+24
-16
lines changed

CI.md

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,38 @@
2323

2424
Continuous Integration is important component of making Apache Beam robust and stable.
2525

26-
Our execution environment for CI is mainly the Jenkins which is available at
27-
[https://ci-beam.apache.org/](https://ci-beam.apache.org/). See
28-
[.test-infra/jenkins/README](.test-infra/jenkins/README.md)
29-
for trigger phrase, status and link of all Jenkins jobs. See Apache Beam Developer Guide for
30-
[Jenkins Tips](https://cwiki.apache.org/confluence/display/BEAM/Jenkins+Tips).
31-
32-
An additional execution environment for CI is [GitHub Actions](https://github.com/features/actions). GitHub Actions
33-
(GA) are very well integrated with GitHub code and Workflow and it has evolved fast in 2019/2020 to become
34-
a fully-fledged CI environment, easy to use and develop for, so we decided to use it for building python source
35-
distribution and wheels.
26+
Our execution environment for CI is the [GitHub Actions](https://github.com/features/actions).
27+
See [.github/workflow/README](.github/workflow/README.md) for trigger phrase,
28+
status and link of all GHA jobs.
29+
30+
GitHub Actions (GHA) are very well integrated with GitHub code and Workflow and
31+
it has evolved fast in 2019/2020 to become a fully-fledged CI environment, easy
32+
to use and develop for, so we decided to use it firstly for a few workflows then
33+
migrated all workflows previously run on Jenkins.
34+
35+
For this reason there are mainly two types of GHA workflows running
36+
- Self-hosted runner GHAs. These were mifrated from Jenkins with workflow name
37+
prefix (beam_*.yml) as well as new workflows added following the same naming
38+
convention, including PreCommit, PostCommit, LoadTest, PerformanceTest, and
39+
several infrastructure jobs. See [.github/workflow/README](.github/workflow/README.md)
40+
for the complete list.
41+
- GitHub-hosted runner GHAs. Most of these jobs exercises the workflow in different
42+
OS (linux, macOS, Windows). They were added prior to Jenkins migration.
43+
Some Linux jobs later migrated to use self-hosted runner.
3644

3745
## GitHub Actions
3846

47+
This section applies to GitHub-hosted runner GHAs. New workflows unless intended
48+
to run on a matrix of OS should refer to Self-hosted runner GHAs [.github/workflow/README](.github/workflow/README.md).
49+
3950
### GitHub actions run types
4051

4152
The following GA CI Job runs are currently run for Apache Beam, and each of the runs have different
4253
purpose and context.
4354

4455
#### Pull request run
4556

46-
Those runs are results of PR from the forks made by contributors. Most builds for Apache Beam fall
57+
Those runs are results of PR from the forks made by contributors. Most builds for Apache Beam fall
4758
into this category. They are executed in the context of the "Fork", not main
4859
Beam Code Repository which means that they have only "read" permission to all the GitHub resources
4960
(container registry, code repository). This is necessary as the code in those PRs (including CI job
@@ -57,15 +68,15 @@ the PR is ready to review and merge.
5768
Those runs are results of direct pushes done by the committers or as result of merge of a Pull Request
5869
by the committers. Those runs execute in the context of the Apache Beam Code Repository and have also
5970
write permission for GitHub resources (container registry, code repository).
60-
The main purpose for the run is to check if the code after merge still holds all the assertions - like
71+
The main purpose for the run is to check if the code after merge still holds all the assertions - like
6172
whether it still builds, all tests are green.
6273

6374
This is needed because some of the conflicting changes from multiple PRs might cause build and test failures
6475
after merge even if they do not fail in isolation.
6576

6677
#### Scheduled runs
6778

68-
Those runs are results of (nightly) triggered job - only for `master` branch. The
79+
Those runs are results of (nightly) triggered job - only for `master` branch. The
6980
main purpose of the job is to check if there was no impact of external dependency changes on the Apache
7081
Beam code (for example transitive dependencies released that fail the build). Another reason for the nightly
7182
build is that the builds tags most recent master with `nightly-master`.

README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@
3030
[![Build python source distribution and wheels](https://github.com/apache/beam/workflows/Build%20python%20source%20distribution%20and%20wheels/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
3131
[![Python tests](https://github.com/apache/beam/workflows/Python%20tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
3232
[![Java tests](https://github.com/apache/beam/workflows/Java%20Tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
33-
[![Go tests (Jenkins)](https://ci-beam.apache.org/job/beam_PreCommit_Go_Cron/lastCompletedBuild/badge/icon?subject=Go%20Tests%28Jenkins%29)](https://ci-beam.apache.org/job/beam_PreCommit_Go_Cron/lastCompletedBuild/)
34-
[![Java tests (Jenkins)](https://ci-beam.apache.org/job/beam_PreCommit_Java_Cron/lastCompletedBuild/badge/icon?subject=Java%20Tests%28Jenkins%29)](https://ci-beam.apache.org/job/beam_PreCommit_Java_Cron/lastCompletedBuild/)
35-
[![Python tests (Jenkins)](https://ci-beam.apache.org/job/beam_PreCommit_Python_Cron/lastCompletedBuild/badge/icon?subject=Python%20Tests%28Jenkins%29)](https://ci-beam.apache.org/job/beam_PreCommit_Python_Cron/lastCompletedBuild/)
3633

3734
## Overview
3835

0 commit comments

Comments
 (0)