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

Report template changes in sync PRs #676

Open
simu opened this issue Oct 31, 2022 · 0 comments
Open

Report template changes in sync PRs #676

simu opened this issue Oct 31, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@simu
Copy link
Member

simu commented Oct 31, 2022

Context

Currently, commodore component sync and commodore package sync generate PR descriptions which only contain the commit hash of the new template version which is getting applied. It would be nice if the PR description also contained a list of all commits (or a link to the template diff) which were used to generate the changes presented in the PR.

Acceptance criteria

  • Commodore renders the template changes as a link to the template diff on GitHub in the sync PR description

Implementation ideas

This will require some additional logic in the dependency templater, as we may be applying different sets of changes for different dependencies. We most likely want to extract the old template commit id from .cruft.json before the update and the new one afterwards. We'll also need to clone the template repo to extract the commit messages for all commits between the two commit ids.

Ideally we'll omit merge commits to reduce the list to only relevant commits.

Alternatively, we could maybe use PR labels (assuming the template is hosted on GitHub) to generate a changelog based on merged PRs since the last template update.

@simu simu added the enhancement New feature or request label Oct 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant