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

Improve _invalid_sequential_version msg. #533

Merged
merged 6 commits into from
Dec 8, 2023
Merged

Improve _invalid_sequential_version msg. #533

merged 6 commits into from
Dec 8, 2023

Conversation

shayandavoodii
Copy link
Contributor

@shayandavoodii shayandavoodii commented Nov 22, 2023

This PR is created due to this discussion. When a version skipping happens, the RegistryCI shows the following message:

... . The following guidelines were not met:

Does not meet sequential version number guideline: version 1.3.2 skips over 1.3.1
Note that the guidelines are only required for the pull request to be merged automatically. However, it is strongly recommended to follow them, since otherwise the pull request needs to be manually reviewed and merged by a human.

In my opinion, this message gives the impression that version skipping is strictly prohibited. It seems to say that you should not do this, but if you did, you need to provide a convincing explanation for why you skipped some versions. Otherwise, the PR will not be merged. However, I can infer that the reason for this check is to prevent any mistakes rather than to ban version skipping. As Mr. Giordano stated:

lots of time [version skipping] is a mistake
a large fraction of [General registry] PRs closed without merge (not for new packages of course) is because of skipped versions which were a mistake.

However, the message I mentioned earlier could imply that developers who deliberately skipped some versions are doing something wrong or problematic, while the main purpose of this check is to prevent mistakes. Therefore, I opened this PR to improve the message. I appreciate your feedback and any suggestions you might have.

@shayandavoodii shayandavoodii changed the title Improved _invalid_sequential_version msg. Improve _invalid_sequential_version msg. Nov 22, 2023
ericphanson
ericphanson previously approved these changes Nov 24, 2023
@ericphanson
Copy link
Member

bors merge

@shayandavoodii
Copy link
Contributor Author

Thank you so much for considering my proposal.

@DilumAluthge
Copy link
Member

bors ping

@ericphanson ericphanson enabled auto-merge December 7, 2023 23:44
@ericphanson ericphanson added this pull request to the merge queue Dec 7, 2023
Merged via the queue into JuliaRegistries:master with commit 07bdb4d Dec 8, 2023
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants