search

aviator-co / av

A command line tool to manage stacked PRs with Aviator
https://aviator.co
MIT License
149 stars 12 forks source link

av adds metadata to PRs that may show up in commit messages #347

Open sarthak opened 2 months ago

sarthak commented 2 months ago

For stacked PRs managed through av, created using av pr create, following text is automatically added to PR description.

<!-- av pr metadata
This information is embedded by the av CLI when creating PRs to track
the status of stacks when using Aviator. Please do not delete or edit
this section of the PR.
\```
{"parent":"main","parentHead":"","trunk":"main"}
\```
-->

In my repository setup, all PR merges are handled automatically through a squash-and-merge strategy which copies the PR description over as the squash commit message while merging the PR. This means that these metadata comments show up in my merged commits as well.

Is it possible to manage this metadata in the local db, instead of PR description to avoid this issue?

jainankit commented 2 months ago

Hi @sarthak thanks for reaching out. This metadata is used by Aviator server for managing the MergeQueue. Currently we don't have a way to support this on the backend without the metadata.

We can potentially accept a contribution to introduce an av config to disable this.