Add full changelog in batch-mirror Noir PRs #4108
Assignees
Labels
A-devops
Area: Devops. E.g. CI / build systems
Comments
ludamad
added a commit
that referenced
this issue
Feb 5, 2024
- We just squash when pushing to Noir. We are more reset the state of the PR so that it is based off the last time we pull with git subrepo pull noir. - We can just do git subrepo pull noir whenever now. It will become the new PR head, and we'll make one squash commit based on it. - History is lost doing this, but regained with a heuristic that looks at the last aztec-packages sync PR that occurred. This also resolves #4108 making sure release-please has a good changelog. misc: - bumps git subrepo version, ended up not being needed, but why not --------- Co-authored-by: ludamad <[email protected]>
TomAFrench
pushed a commit
that referenced
this issue
Feb 7, 2024
- We just squash when pushing to Noir. We are more reset the state of the PR so that it is based off the last time we pull with git subrepo pull noir. - We can just do git subrepo pull noir whenever now. It will become the new PR head, and we'll make one squash commit based on it. - History is lost doing this, but regained with a heuristic that looks at the last aztec-packages sync PR that occurred. This also resolves #4108 making sure release-please has a good changelog. misc: - bumps git subrepo version, ended up not being needed, but why not --------- Co-authored-by: ludamad <[email protected]>
michaelelliot
pushed a commit
to Swoir/noir_rs
that referenced
this issue
Feb 28, 2024
- We just squash when pushing to Noir. We are more reset the state of the PR so that it is based off the last time we pull with git subrepo pull noir. - We can just do git subrepo pull noir whenever now. It will become the new PR head, and we'll make one squash commit based on it. - History is lost doing this, but regained with a heuristic that looks at the last aztec-packages sync PR that occurred. This also resolves AztecProtocol#4108 making sure release-please has a good changelog. misc: - bumps git subrepo version, ended up not being needed, but why not --------- Co-authored-by: ludamad <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Problem
Noir changes happening in this repository are currently mirrored in batches to the Noir repository (e.g. noir-lang/noir#4011), where the batching PR adds only its title (e.g. "Sync
aztec-packages") but not its sub-PR's (e.g. "implement keccakf1600 in brillig") to Noir's changelog.This causes unnecessary friction for changelog readers to discover and learn details of the individual changes being batched.
Take v0.23.0's changelog as an example:
Possible solution
The batching PR should add each of its sub-PRs' titles to the Noir changelog, in replacement of its own title.
One possible way would be to:
Additional note
Make sure we use the full link to sub-PRs (e.g.
https://github.com/AztecProtocol/aztec-packages/pull/3914) rather than just their numbers (e.g.#3914).GitHub would automatically link to unrelated PRs with the same number in the Noir repository if it contains just numbers (e.g.
https://github.com/noir-lang/noir/pull/3914).The text was updated successfully, but these errors were encountered: