- Notifications
You must be signed in to change notification settings - Fork359
feat: Add support for ref comparison#1408
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:master
Are you sure you want to change the base?
Conversation
| ref(qualifiedName: $baseRef) { | ||
| compare(headRef: $targetCommitish) { |
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.
the goal here is to get something like the result of this rest endpoint:
https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#compare-two-commits
kylejPomelo commentedDec 10, 2024
this feature would be useful to my use case. We're managing different types of releases from a monorepo, and whenever one type releases, the commits of the next release, or either type, are calculated since that release. I'd like to use this and manually derive the ref on our end and provide that to release-drafter if possible |
@jarojasm95 I don't think we need the option to turn this off. I believe would provide a better result then using dates as in we should always use the refs instead of dates. To determine commits that should be included. I would love to see this PR merged. |
ScumbagScalawag commentedJul 7, 2025
Maybe I can add a little clarity on direction for this feature of "ref comparisons", specifically release notes that can show the diff between two known commits/tags, like Theautomatically-generated release notes' The correct solution, which wouldpotentially also solve issues like#1382 and#1260, would be to make sure the diff to calculate PR's between releases is always determined by topological order of git history. I've tested this logic out in a (private) repo that has Pull requests that were new to a "release" branch, but older than the last release + release notes and using the topological history (or Not sure if this isexactly what's going on, but it's one of the problems I've found with calculating PR diffs for the sake of another complex release train I'm managing. I can elaborate more if needed, but I have a suspicion that the topological ordering is necessary not just to feature match GitHub's |
Uh oh!
There was an error while loading.Please reload this page.
This project is great ❤️
I've found myself using it more and more, however I've found that it does not work as I'd expect for some git workflows, specifically when using "merge commits" to the branch where
release-drafteris configured.This is happening because
release-drafteruses the date of the last release to list commits to draft a new release, however if commits were merged with an earlier date they get ignored!This PR adds a configuration option to support such workflows in a backwards-compatible way.