higress-update-envoy-gateway

Builds Envoy packages, publishes releases, and updates Higress gateway image dependencies for e2e validation.

9.3k|1.3k|Updated Oct 27, 2022
One-click install
npx skills add https://github.com/alibaba/higress --skill higress-update-envoy-gateway
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: higress-update-envoy-gateway
Source: https://github.com/alibaba/higress/tree/main/.agents/skills/higress-update-envoy-gateway
Command: npx skills add https://github.com/alibaba/higress --skill higress-update-envoy-gateway

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Updating Higress to consume a new Envoy build involves many error-prone manual steps: compiling Envoy packages, publishing them to the higress-group/proxy releases, editing Makefile.core.mk dependency variables, building and retagging the gateway image, and pushing signed-off commits. This Skill codifies that entire workflow so e2e tests can consume a new Envoy build without missing a step.

Core Features & Use Cases

  • Envoy Package Build and Release: Builds envoy-alpha and envoy-symbol tarballs from the current branch via make build-envoy and publishes them to higress-group/proxy releases with correctly renamed assets using the GitHub CLI.
  • Makefile Dependency Updates: Sets ENVOY_PACKAGE_URL_PATTERN and ENVOY_LATEST_IMAGE_TAG in Makefile.core.mk so builds and e2e tests reference the new Envoy artifacts.
  • Gateway Image Build and Push: Runs make build-gateway-local, retags the proxyv2 image as gateway, verifies image IDs match, and pushes the gateway image to the Higress registry.
  • Use Case: A maintainer needs Higress e2e tests to validate a new Envoy RC build. The Skill builds the packages, creates the proxy release, updates the Makefile, pushes the gateway image, and prepares a DCO-signed PR commit.

Quick Start

Use the higress-update-envoy-gateway skill to build Envoy packages from the current branch, publish them to higress-group/proxy, update Makefile.core.mk, and push a new gateway image for e2e validation.

Frequently Asked Questions about higress-update-envoy-gateway

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update Higress to use a new Envoy build for e2e tests?

Build Envoy packages with make build-envoy, publish them as a release in higress-group/proxy, update ENVOY_PACKAGE_URL_PATTERN and ENVOY_LATEST_IMAGE_TAG in Makefile.core.mk, then build and push the gateway image so e2e targets consume it.

How do I publish Envoy packages to the higress-group/proxy repository?

Copy the built artifacts to temporary files named envoy-amd64.tar.gz and envoy-symbol-amd64.tar.gz, then run gh release create with --repo higress-group/proxy, the target branch, and --generate-notes. Verify with gh release view.

Why does the gateway image tag differ from the proxyv2 image?

The build target emits a proxyv2 image, so you must retag it as gateway with docker tag and confirm both image IDs match. The gateway tag is what ENVOY_LATEST_IMAGE_TAG and e2e install targets reference.

What should I do when the DCO check fails on my Higress PR?

Amend the unsigned commit with git commit --amend --no-edit --signoff, force-push with --force-with-lease, and recheck status using gh pr checks. Always commit with git commit -s to sign off initially.

What permissions are needed to run make build-gateway-local?

The build needs Docker daemon access, network access to download the Envoy release, and write access to repo and submodule state. If sandboxed commands fail with read-only or socket errors, rerun with elevated permissions and a justification.