Remove ability to check bin-only targets, to fix doc = false issue.
#663
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Because of a complex web of edge cases, we can _either_ choose to continue to support our legacy behavior of allowing bin-only targets to be semver-checked, _or_ we can support semver-checking lib targets that set `doc = false`. Semver-checking bin-only targets doesn't make a lot of sense, since they cannot be used as a library anyway. This functionality was always slated for removal, I just wish we had more time to deprecate & warn on it before just ripping it out like this. Now we're in a tight spot, and this is definitely the lesser evil -- we're making the tool work for library users who produce an API that can reasonably be checked and used as such. Fixes #660.
obi1kenobi
added
A-cli
This was referenced Feb 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Because of a complex web of edge cases, we can either choose to continue to support our legacy behavior of allowing bin-only targets to be semver-checked, or we can support semver-checking lib targets that set
doc = false. Semver-checking bin-only targets doesn't make a lot of sense, since they cannot be used as a library anyway. This functionality was always slated for removal, I just wish we had more time to deprecate & warn on it before just ripping it out like this.Now we're in a tight spot, and this is definitely the lesser evil -- we're making the tool work for library users who produce an API that can reasonably be checked and used as such.
Fixes #660.