Skip to content
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

Draft a workflow to help keep PR up-to-date #4669

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

t0yv0
Copy link
Member

@t0yv0 t0yv0 commented Oct 25, 2024

One of the maintainer chores on this repository is keeping schema and SDKs re-generated and up-to-date. This introduces a workflow to help with that. When working on a PR maintainer/feature, the automation will stand up and keep re-generating an auxillary PR with a branch called "maintainer/feature-gen". This auxillary PR will:

  • use the original PR as a base
  • contain all the same commits as the original PR
  • append extra commits based on:
    • re-generating schema
    • re-generating SDK for each language

This PR will appear then the original PR is opened, and will be force-pushed to and rebuilt any time the original PR is changing by adding commits or force-pushing.

This may enable maintainers to review source-only changes and check them in quickly. The automatic changes are still worth consulting for review. Having these in two PRs has some trade-offs of making it easier on the author vs harder on the reviewer, so this workflow may be considered an experiment.

@t0yv0 t0yv0 marked this pull request as ready for review October 25, 2024 20:01
@t0yv0
Copy link
Member Author

t0yv0 commented Oct 25, 2024

Might need to land it on master first and iterate on this a bit, since I'm not sure we can test a workflow otherwise before it is merged.

@t0yv0
Copy link
Member Author

t0yv0 commented Oct 25, 2024

Oh never mind, this is somehow running already. SO I can experiment without merging. Will do.

Copy link

Does the PR have any schema changes?

Looking good! No breaking changes found.
No new resources/functions.

Maintainer note: consult the runbook for dealing with any breaking changes.

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.

1 participant