Skip to content

Commit

Permalink
dependencies: patch policy. (#13094)
Browse files Browse the repository at this point in the history
Clarify the conditions under which patches may be used on external deps.

Signed-off-by: Harvey Tuch <[email protected]>
  • Loading branch information
htuch authored Sep 14, 2020
1 parent 64bd631 commit 2709b6b
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions DEPENDENCY_POLICY.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,25 @@ basis:
Where possible, we prefer the latest release version for external dependencies, rather than master
branch GitHub SHA tarballs.

## Dependency patches

Occasionally it is necessary to introduce an Envoy-side patch to a dependency in a `.patch` file.
These are typically applied in [bazel/repositories.bzl](bazel/repositories.bzl). Our policy on this
is as follows:

* Patch files impede dependency updates. They are expedient at creation time but are a maintenance
penalty. They reduce the velocity and increase the effort of upgrades in response to security
vulnerabilities in external dependencies.

* No patch will be accepted without a sincere and sustained effort to upstream the patch to the
dependency's canonical repository.

* There should exist a plan-of-record, filed as an issue in Envoy or the upstream GitHub tracking
elimination of the patch.

* Every patch must have comments at its point-of-use in [bazel/repositories.bzl](bazel/repositories.bzl)
providing a rationale and detailing the tracking issue.

## Policy exceptions

The following dependencies are exempt from the policy:
Expand Down

0 comments on commit 2709b6b

Please sign in to comment.