-
-
Notifications
You must be signed in to change notification settings - Fork 75
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
Changed all baseline rustdoc generations to use placeholder manifest #341
Changed all baseline rustdoc generations to use placeholder manifest #341
Conversation
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.
I like the direction. Just needs some polishing for maintainability.
I'd also feel a lot more comfortable with these changes if we had automated tests over them that use path and gitrev arguments in the CLI. Consider adding a new job that looks to catch one of the known (but not yanked) semver violations by path and by gitrev, and ensures the output shows the semver issue was found?
Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>
Do you have some specific crates / versions in mind? |
I know the affected version for |
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.
Looks good so far. The tests are the biggest remaining thing, since I believe our entire test suite currently uses registry-based baselines.
I suggested a couple of tiny incremental improvements as well.
I'm not entirely sure whether I understood what you mean, but I've added a test in the CI. And also I've found a bug in the previous CI :) |
This PR also fixes #344. |
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.
Awesome job!
This PR is a continuation of #340.
This PR changes the way baseline rustdoc of
PathBaseline
is being generated -- similarly toRegistryBaseline
, a placeholder project is created (with a dependency to the true project) on which the rustdoc is generated.I was worried about two possible places which could have bugs, but after writing this PR, it turned out to not be a problem: