add a note about pre-v1 breaking changes #597
Open
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
We do have this info, so we could figure out a way to propagate it. |
|
btw this code change only affects the docs, not the actual message being shown to the user in the PR |
|
Should be ready for review now. |
ericphanson
reviewed
Feb 25, 2025
| end | ||
| if version < v"1.0.0" | ||
| msg *= """ | ||
| Given this is a pre-v1.0.0 release, you may have not intended to make a breaking change release. [More information](https://pkgdocs.julialang.org/v1/compatibility/#compat-pre-1.0) on Julia's handling of pre-v1.0.0 versioning. |
There was a problem hiding this comment.
I think we should make this more "actionable", like if this was intended do X, if it was not intended do Y
There was a problem hiding this comment.
maybe:
Suggested change
| Given this is a pre-v1.0.0 release, you may have not intended to make a breaking change release. [More information](https://pkgdocs.julialang.org/v1/compatibility/#compat-pre-1.0) on Julia's handling of pre-v1.0.0 versioning. | |
| Given this is a pre-v1.0.0 release, you may have not intended to make a breaking change release (see [here](https://pkgdocs.julialang.org/v1/compatibility/#compat-pre-1.0) for more on Julia's handling of pre-v1.0.0 versioning). **If you did not mean to make a breaking release**, leave a comment that the PR should be closed, update the version number in your package, and trigger registration again. |
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.
Ideally we'd not show this if it isn't pre-v1 but I couldn't see a way to do that.Now implemented.