Skip to content

Commit e136b95

Browse files
authored
docs: clean up docs for azp migration (envoyproxy#13558)
Signed-off-by: Lizan Zhou <[email protected]>
1 parent 2fa85c6 commit e136b95

14 files changed

+22
-94
lines changed

.bazelrc

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
# Bazel doesn't need more than 200MB of memory for local build based on memory profiling:
44
# https://docs.bazel.build/versions/master/skylark/performance.html#memory-profiling
55
# The default JVM max heapsize is 1/4 of physical memory up to 32GB which could be large
6-
# enough to consume all memory constrained by cgroup in large host, which is the case in CircleCI.
6+
# enough to consume all memory constrained by cgroup in large host.
77
# Limiting JVM heapsize here to let it do GC more when approaching the limit to
88
# leave room for compiler/linker.
9-
# The number 2G is choosed heuristically to both support in CircleCI and large enough for RBE.
9+
# The number 2G is chosen heuristically to both support large VM and small VM with RBE.
1010
# Startup options cannot be selected via config.
1111
startup --host_jvm_args=-Xmx2g
1212

DEVELOPER.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Developer documentation
22

3-
Envoy is built using the Bazel build system. CircleCI builds, tests, and runs coverage against all pull requests and the master branch.
3+
Envoy is built using the Bazel build system. Our CI on Azure Pipelines builds, tests, and runs coverage against
4+
all pull requests and the master branch.
45

56
To get started building Envoy locally, see the [Bazel quick start](https://github.com/envoyproxy/envoy/blob/master/bazel/README.md#quick-start-bazel-build-for-developers).
67
To run tests, there are Bazel [targets](https://github.com/envoyproxy/envoy/blob/master/bazel/README.md#testing-envoy-with-bazel) for Google Test.

README.md

-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ involved and how Envoy plays a role, read the CNCF
1010

1111
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1266/badge)](https://bestpractices.coreinfrastructure.org/projects/1266)
1212
[![Azure Pipelines](https://dev.azure.com/cncf/envoy/_apis/build/status/11?branchName=master)](https://dev.azure.com/cncf/envoy/_build/latest?definitionId=11&branchName=master)
13-
[![CircleCI](https://circleci.com/gh/envoyproxy/envoy/tree/master.svg?style=shield)](https://circleci.com/gh/envoyproxy/envoy/tree/master)
1413
[![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/envoy.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:envoy)
1514
[![Jenkins](https://powerci.osuosl.org/buildStatus/icon?job=build-envoy-static-master&subject=ppc64le%20build)](https://powerci.osuosl.org/job/build-envoy-static-master/)
1615

REPO_LAYOUT.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ This is a high level overview of how the repository is laid out to both aid in c
44
as well as to clearly specify how extensions are added to the repository. The top level directories
55
are:
66

7-
* [.circleci/](.circleci/): Configuration for [CircleCI](https://circleci.com/gh/envoyproxy).
7+
* [.azure-pipelines/](.azure-pipelines/): Configuration for
8+
[Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/).
89
* [api/](api/): Envoy data plane API.
910
* [bazel/](bazel/): Configuration for Envoy's use of [Bazel](https://bazel.build/).
1011
* [ci/](ci/): Scripts used both during CI as well as to build Docker containers.

STYLE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# C++ coding style
22

33
* The Envoy source code is formatted using clang-format. Thus all white spaces, etc.
4-
issues are taken care of automatically. The CircleCI tests will automatically check
4+
issues are taken care of automatically. The Azure Pipelines will automatically check
55
the code format and fail. There are make targets that can both check the format
66
(check_format) as well as fix the code format for you (fix_format). Errors in
77
.clang-tidy are enforced while other warnings are suggestions. Note that code and

api/CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,11 @@ generated RST files are also viewable in `generated/rst`.
5050

5151
Note also that the generated documentation can be viewed in CI:
5252

53-
1. Open docs job in CircleCI.
54-
2. Navigate to "artifacts" tab.
55-
3. Expand files and click on `index.html`.
53+
1. Open docs job in Azure Pipelines.
54+
2. Navigate to "Upload Docs to GCS" log.
55+
3. Click on the link there.
5656

57-
If you do not see an artifacts tab this is a bug in CircleCI. Try logging out and logging back in.
57+
If you do not see "Upload Docs to GCS" or it is failing, that means the docs are not built correctly.
5858

5959
### Documentation guidelines
6060

ci/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ and an image based on Windows2019.
55

66
## Ubuntu Envoy image
77

8-
The Ubuntu based Envoy Docker image at [`envoyproxy/envoy-build:<hash>`](https://hub.docker.com/r/envoyproxy/envoy-build/) is used for CircleCI checks,
8+
The Ubuntu based Envoy Docker image at [`envoyproxy/envoy-build:<hash>`](https://hub.docker.com/r/envoyproxy/envoy-build/) is used for CI checks,
99
where `<hash>` is specified in [`envoy_build_sha.sh`](https://github.com/envoyproxy/envoy/blob/master/ci/envoy_build_sha.sh). Developers
1010
may work with the latest build image SHA in [envoy-build-tools](https://github.com/envoyproxy/envoy-build-tools/blob/master/toolchains/rbe_toolchains_config.bzl#L8)
1111
repo to provide a self-contained environment for building Envoy binaries and running tests that reflects the latest built Ubuntu Envoy image.
@@ -189,10 +189,10 @@ This build the Ubuntu based `envoyproxy/envoy-build-ubuntu` image, and the final
189189
190190
# macOS Build Flow
191191
192-
The macOS CI build is part of the [CircleCI](https://circleci.com/gh/envoyproxy/envoy) workflow.
192+
The macOS CI build is part of the [Azure Pipelines](https://dev.azure.com/cncf/envoy/_build) workflow.
193193
Dependencies are installed by the `ci/mac_ci_setup.sh` script, via [Homebrew](https://brew.sh),
194-
which is pre-installed on the CircleCI macOS image. The dependencies are cached are re-installed
195-
on every build. The `ci/mac_ci_steps.sh` script executes the specific commands that
194+
which is pre-installed on the [Azure Pipelines macOS image](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-10.15-Readme.md).
195+
The dependencies are cached and re-installed on every build. The `ci/mac_ci_steps.sh` script executes the specific commands that
196196
build and test Envoy. Note that the full version of Xcode (not just Command Line Tools) is required.
197197
198198
# Coverity Scan Build Flow

ci/do_circle_ci.sh

-51
This file was deleted.

ci/mac_ci_setup.sh

-6
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,6 @@ do
5151
is_installed "${DEP}" || install "${DEP}"
5252
done
5353

54-
if [ -n "$CIRCLECI" ]; then
55-
# bazel uses jgit internally and the default circle-ci .gitconfig says to
56-
# convert https://github.com to ssh://[email protected], which jgit does not support.
57-
mv ~/.gitconfig ~/.gitconfig_save
58-
fi
59-
6054
# Required as bazel and a foreign bazelisk are installed in the latest macos vm image, we have
6155
# to unlink/overwrite them to install bazelisk
6256
echo "Installing bazelisk"

ci/repokitteh/modules/azure_pipelines.star

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def _get_azp_checks():
2525
return checks
2626

2727
def _retry(config, comment_id, command):
28-
msgs = "Retrying Azure Pipelines, to retry CircleCI checks, use `/retest-circle`.\n"
28+
msgs = "Retrying Azure Pipelines.\n"
2929
checks = _get_azp_checks()
3030

3131
retried_checks = []

docs/README.md

+5-8
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,17 @@ To use this method you will need a minimum of 4-5GB of disk space available to a
3434

3535
# Creating a Pull Request with documentation changes
3636

37-
When you create a Pull Request the documentation is rendered by CircleCI.
38-
39-
If you are logged in to CircleCI (it is possible to authenticate using your Github account), you can view
40-
the rendered changes.
37+
When you create a Pull Request the documentation is rendered by Azure Pipelines.
4138

4239
To do this:
43-
- click `Details` in the `ci/circleci: docs` check at the bottom of the Pull Request.
44-
- click `ARTIFACTS` in the CircleCI dashboard
45-
- browse to the documentation root at `generated/docs/index.html`.
40+
1. Open docs job in Azure Pipelines.
41+
2. Navigate to "Upload Docs to GCS" log.
42+
3. Click on the link there.
4643

4744
# How the Envoy website and docs are updated
4845

4946
1. The docs are published to [docs/envoy/latest](https://github.com/envoyproxy/envoyproxy.github.io/tree/master/docs/envoy/latest)
50-
on every commit to master. This process is handled by CircleCI with the
47+
on every commit to master. This process is handled by Azure Pipelines with the
5148
[`publish.sh`](https://github.com/envoyproxy/envoy/blob/master/docs/publish.sh) script.
5249

5350
2. The docs are published to [docs/envoy](https://github.com/envoyproxy/envoyproxy.github.io/tree/master/docs/envoy)

docs/publish.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/bash
22

3-
# This is run on every commit that CircleCI picks up. It assumes that docs have already been built
3+
# This is run on every commit that Azure Pipelines picks up. It assumes that docs have already been built
44
# via docs/build.sh. The push behavior differs depending on the nature of the commit:
55
# * Tag commit (e.g. v1.6.0): pushes docs to versioned location, e.g.
66
# https://www.envoyproxy.io/docs/envoy/v1.6.0/.

repokitteh.star

-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ pin("github.com/repokitteh/modules", "4ee2ed0c3622aad7fcddc04cb5dc866e44a541e6")
33
use("github.com/repokitteh/modules/assign.star")
44
use("github.com/repokitteh/modules/review.star")
55
use("github.com/repokitteh/modules/wait.star")
6-
use("github.com/repokitteh/modules/circleci.star", secret_token=get_secret('circle_token'))
76
use("github.com/envoyproxy/envoy/ci/repokitteh/modules/azure_pipelines.star", secret_token=get_secret('azp_token'))
87
use("github.com/envoyproxy/envoy/ci/repokitteh/modules/newcontributor.star")
98
use(
@@ -37,7 +36,6 @@ use(
3736
],
3837
)
3938

40-
alias('retest-circle', 'retry-circle')
4139
alias('retest', 'retry-azp')
4240

4341
def _backport():

source/docs/repokitteh.md

-11
Original file line numberDiff line numberDiff line change
@@ -75,17 +75,6 @@ Sets the label `waiting:any` on a PR. When a new commit is pushed or any comment
7575

7676
[Demo PR](https://github.com/envoyproxy/envoybot/pull/15)
7777

78-
### [CircleCI Retest](https://github.com/repokitteh/modules/blob/master/circleci.star)
79-
Restart failed CircleCI tests.
80-
81-
Example:
82-
```
83-
/retest-circle
84-
```
85-
Restarts all failed CircleCI tests, as reported in the commit statuses.
86-
87-
[Demo PR](https://github.com/envoyproxy/envoy/pull/12613#issuecomment-676141200)
88-
8978
### [Azure Pipelines Retest](https://github.com/envoyproxy/envoy/blob/master/ci/repokitteh/modules/azure_pipelines.star)
9079
Restart failed Azure pipelines.
9180

0 commit comments

Comments
 (0)