Skip to content

Latest commit

 

History

History
35 lines (31 loc) · 2.01 KB

MAINTAINERS.md

File metadata and controls

35 lines (31 loc) · 2.01 KB
Raw

Maintainers

This document provides maintenance procedures to assist maintainers.

Updates to the Envoy and Nighthawk dependency for Salvo

Salvo reuses large parts of Envoy's and Nighthawk's build system and codebase, so keeping Salvo up to date with Envoy's and Nighthawk's changes is an important maintenance task. When performing the update, follow this procedure:

  1. Create a fork of Salvo, or fetch upstream and merge changes into your fork if you already have one.
  2. Create a new branch from main, e.g. envoy-update.
  3. Sync (copy) .bazelrc from Nighthawk's version to update our build configurations. Be sure to retain our local modifications, all lines that are unique to Salvo are marked with comment # Salvo unique.
  4. Determine the Envoy commit Nighthawk is updated to from here.
  5. Sync (copy) ci/run_envoy_docker.sh from Envoy's version at the commit in step(4). Be sure to retain our local modifications, all lines that are unique to Salvo are marked with comment # Salvo unique.
  6. Sync (copy) ci/envoy_build_sha.sh from Envoy's version at the commit in step(4). Be sure to retain our local modifications, all lines that are unique to Salvo are marked with comment # Salvo unique.
  7. Run ci/do_ci.sh test. Sometimes the dependency update comes with changes that break our build. Include any changes required to Salvo to fix that in the same PR.
  8. If the PR ends up modifying any python files, execute ci/do_ci.sh fix_format to reformat the files and avoid a CI failure.
  9. Create a PR with a title like Syncing configuration files from Nighthawk and Envoy (..date here..), describe all performed changes in the PR's description.