Skip to content

feat: add PR link support to changelog schema #2652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

agrawroh
Copy link

@agrawroh agrawroh commented May 8, 2025

Description

This PR add some schema changes to support PR links in Envoy change-logs.

Example Usage

In a changelog entry, you can now include a PR(s) field called prs:

behavior_changes:
- area: aws_iam
  change: |
    As announced in November 2024, the grpc_credentials/aws_iam extension is being deleted.
    Any configuration referencing this extension will fail to load.
  prs: ["54321", "67890"]

Or,

behavior_changes:
- area: aws_iam
  change: |
    As announced in November 2024, the grpc_credentials/aws_iam extension is being deleted.
    Any configuration referencing this extension will fail to load.
  prs:
  - 12345
  - 67890

As next steps, to automate the process of adding PR links to change-log entries, we can create a GitHub workflow that adds PR links to change-log entries when PRs are merged.

@envoyproxy envoyproxy deleted a comment from netlify bot May 8, 2025
Copy link
Member

@phlax phlax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @agrawroh

i think this should probably be prs - ie associated to prs rather than locked to a single one

@agrawroh agrawroh force-pushed the feat-pr-links branch 4 times, most recently from 26857e7 to 5d59aa4 Compare May 8, 2025 13:24
@agrawroh agrawroh requested a review from phlax May 8, 2025 13:28
@agrawroh agrawroh requested a review from phlax May 8, 2025 14:09
Copy link
Member

@phlax phlax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry for delay in reviewing/testing this

i think this new field should be a list of ints as that is kinda what is expected

currently its not used anywhere - but im guesing that when hooked up the docs will display the list of linked prs in the docs - happy for that to be addressed separately

ftr, i tested this with:

$ bazel run @envoy_repo//:sync
$ bazel run @envoy_repo//:release
$ bazel run @envoy_repo//:dev

... from envoy repo - all work correctly assuming the schema is correct, and i also built the docs from changelog with new schema

@agrawroh agrawroh requested a review from phlax July 11, 2025 01:40
@agrawroh agrawroh force-pushed the feat-pr-links branch 2 times, most recently from bcf2b3f to 49596dc Compare July 11, 2025 02:34
Signed-off-by: Rohit Agrawal <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants