-
Notifications
You must be signed in to change notification settings - Fork 13
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this 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
26857e7
to
5d59aa4
Compare
envoy.base.utils/envoy/base/utils/abstract/project/changelog.py
Outdated
Show resolved
Hide resolved
There was a problem hiding this 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
envoy.base.utils/envoy/base/utils/abstract/project/changelog.py
Outdated
Show resolved
Hide resolved
Signed-off-by: Rohit Agrawal <[email protected]>
Signed-off-by: Rohit Agrawal <[email protected]>
bcf2b3f
to
49596dc
Compare
Signed-off-by: Rohit Agrawal <[email protected]>
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
:Or,
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.