forked from envoyproxy/envoy
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Various fixes Signed-off-by: Matt Klein <[email protected]>
- Loading branch information
1 parent
1d1b708
commit 17e8151
Showing
60 changed files
with
183 additions
and
183 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,7 +9,7 @@ schedules: | |
displayName: Hourly CVE scan | ||
branches: | ||
include: | ||
- master | ||
- main | ||
always: true | ||
|
||
pool: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
trigger: | ||
branches: | ||
include: | ||
- "master" | ||
- "main" | ||
- "release/v*" | ||
tags: | ||
include: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,38 @@ | ||
# Developer documentation | ||
|
||
Envoy is built using the Bazel build system. Our CI on Azure Pipelines builds, tests, and runs coverage against | ||
all pull requests and the master branch. | ||
all pull requests and the main branch. | ||
|
||
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). | ||
To run tests, there are Bazel [targets](https://github.com/envoyproxy/envoy/blob/master/bazel/README.md#testing-envoy-with-bazel) for Google Test. | ||
To generate a coverage report, there is a [coverage build script](https://github.com/envoyproxy/envoy/blob/master/bazel/README.md#coverage-builds). | ||
To get started building Envoy locally, see the [Bazel quick start](https://github.com/envoyproxy/envoy/blob/main/bazel/README.md#quick-start-bazel-build-for-developers). | ||
To run tests, there are Bazel [targets](https://github.com/envoyproxy/envoy/blob/main/bazel/README.md#testing-envoy-with-bazel) for Google Test. | ||
To generate a coverage report, there is a [coverage build script](https://github.com/envoyproxy/envoy/blob/main/bazel/README.md#coverage-builds). | ||
|
||
If you plan to contribute to Envoy, you may find it useful to install the Envoy [development support toolchain](https://github.com/envoyproxy/envoy/blob/master/support/README.md), which helps automate parts of the development process, particularly those involving code review. | ||
If you plan to contribute to Envoy, you may find it useful to install the Envoy [development support toolchain](https://github.com/envoyproxy/envoy/blob/main/support/README.md), which helps automate parts of the development process, particularly those involving code review. | ||
|
||
Below is a list of additional documentation to aid the development process: | ||
|
||
- [General build and installation documentation](https://www.envoyproxy.io/docs/envoy/latest/start/start) | ||
|
||
- [Building and testing Envoy with Bazel](https://github.com/envoyproxy/envoy/blob/master/bazel/README.md) | ||
- [Building and testing Envoy with Bazel](https://github.com/envoyproxy/envoy/blob/main/bazel/README.md) | ||
|
||
- [Managing external dependencies with Bazel](https://github.com/envoyproxy/envoy/blob/master/bazel/EXTERNAL_DEPS.md) | ||
- [Managing external dependencies with Bazel](https://github.com/envoyproxy/envoy/blob/main/bazel/EXTERNAL_DEPS.md) | ||
|
||
- [Guide to Envoy Bazel rules (managing `BUILD` files)](https://github.com/envoyproxy/envoy/blob/master/bazel/DEVELOPER.md) | ||
- [Guide to Envoy Bazel rules (managing `BUILD` files)](https://github.com/envoyproxy/envoy/blob/main/bazel/DEVELOPER.md) | ||
|
||
- [Using Docker for building and testing](https://github.com/envoyproxy/envoy/tree/master/ci) | ||
- [Using Docker for building and testing](https://github.com/envoyproxy/envoy/tree/main/ci) | ||
|
||
- [Guide to contributing to Envoy](https://github.com/envoyproxy/envoy/blob/master/CONTRIBUTING.md) | ||
- [Guide to contributing to Envoy](https://github.com/envoyproxy/envoy/blob/main/CONTRIBUTING.md) | ||
|
||
- [Overview of Envoy's testing frameworks](https://github.com/envoyproxy/envoy/blob/master/test/README.md) | ||
- [Overview of Envoy's testing frameworks](https://github.com/envoyproxy/envoy/blob/main/test/README.md) | ||
|
||
- [Overview of how to write integration tests for new code](https://github.com/envoyproxy/envoy/blob/master/test/integration/README.md) | ||
- [Overview of how to write integration tests for new code](https://github.com/envoyproxy/envoy/blob/main/test/integration/README.md) | ||
|
||
- [Envoy filter example project (how to consume and extend Envoy as a submodule)](https://github.com/envoyproxy/envoy-filter-example) | ||
|
||
- [Performance testing Envoy with `tcmalloc`/`pprof`](https://github.com/envoyproxy/envoy/blob/master/bazel/PPROF.md) | ||
- [Performance testing Envoy with `tcmalloc`/`pprof`](https://github.com/envoyproxy/envoy/blob/main/bazel/PPROF.md) | ||
|
||
And some documents on components of Envoy architecture: | ||
|
||
- [Envoy flow control](https://github.com/envoyproxy/envoy/blob/master/source/docs/flow_control.md) | ||
- [Envoy flow control](https://github.com/envoyproxy/envoy/blob/main/source/docs/flow_control.md) | ||
|
||
- [Envoy's subset load balancer](https://github.com/envoyproxy/envoy/blob/master/source/docs/subset_load_balancer.md) | ||
- [Envoy's subset load balancer](https://github.com/envoyproxy/envoy/blob/main/source/docs/subset_load_balancer.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -38,7 +38,7 @@ | |
The areas of specialization listed in [OWNERS.md](OWNERS.md) can be used to help with routing | ||
an issue/question to the right person. | ||
* Triage build issues - file issues for known flaky builds or bugs, and either fix or find someone | ||
to fix any master build breakages. | ||
to fix any main build breakages. | ||
* During GitHub issue triage, apply all applicable [labels](https://github.com/envoyproxy/envoy/labels) | ||
to each new issue. Labels are extremely useful for future issue follow up. Which labels to apply | ||
is somewhat subjective so just use your best judgment. A few of the most important labels that are | ||
|
@@ -77,7 +77,7 @@ or you can subscribe to the iCal feed [here](webcal://kubernetes.app.opsgenie.co | |
"is:open is:issue milestone:[current milestone]" and either hold off until | ||
they are fixed or bump them to the next milestone. | ||
* Begin marshalling the ongoing PR flow in this repo. Ask maintainers to hold off merging any | ||
particularly risky PRs until after the release is tagged. This is because we aim for master to be | ||
particularly risky PRs until after the release is tagged. This is because we aim for main to be | ||
at release candidate quality at all times. | ||
* Do a final check of the [release notes](docs/root/version_history/current.rst): | ||
* Make any needed corrections (grammar, punctuation, formatting, etc.). | ||
|
@@ -91,7 +91,7 @@ or you can subscribe to the iCal feed [here](webcal://kubernetes.app.opsgenie.co | |
release, please also make sure there's a stable maintainer signed up for next quarter, | ||
and the deadline for the next release is documented in the release schedule. | ||
* Get a review and merge. | ||
* Wait for tests to pass on [master](https://dev.azure.com/cncf/envoy/_build). | ||
* Wait for tests to pass on [main](https://dev.azure.com/cncf/envoy/_build). | ||
* Create a [tagged release](https://github.com/envoyproxy/envoy/releases). The release should | ||
start with "v" and be followed by the version number. E.g., "v1.6.0". **This must match the | ||
[VERSION](VERSION).** | ||
|
@@ -106,7 +106,7 @@ or you can subscribe to the iCal feed [here](webcal://kubernetes.app.opsgenie.co | |
* Make sure we tweet the new release: either have Matt do it or email [email protected] and ask them to do an Envoy account | ||
post. | ||
* Do a new PR to setup the next version | ||
* Update [VERSION](VERSION) to the next development release. E.g., "1.7.0-dev". | ||
* Update [VERSION](VERSION) to the next development release. E.g., "1.7.0-dev". | ||
* `git mv docs/root/version_history/current.rst docs/root/version_history/v1.6.0.rst`, filling in the previous | ||
release version number in the filename and delete empty sections (like Incompatible Behavior Changes, Minor Bahavior Changes, etc). | ||
Add an entry for the new file in the `toctree` in | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.