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

New package: RankMS v0.1.0 #116327

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

JuliaRegistrator
Copy link
Contributor

UUID: 64d803ca-a168-423f-ba94-4afacd1091d3
Repo: https://github.com/yanjer/RankMS.jl.git
Tree: 4fc01668d95277eb01521610240b8324e002d82e

Registrator tree SHA: 191228b6dd8b9d0e2965ae3e705fe54c51dcfee8
Copy link
Contributor

Hello, I am an automated registration bot. I help manage the registration process by checking your registration against a set of AutoMerge guidelines. If all these guidelines are met, this pull request will be merged automatically, completing your registration. It is strongly recommended to follow the guidelines, since otherwise the pull request needs to be manually reviewed and merged by a human.

1. New package registration

Please make sure that you have read the package naming guidelines.

2. AutoMerge Guidelines which are not met ❌

  • I was not able to load the package (i.e. import RankMS failed). See the AutoMerge logs for details.

3. Needs action: here's what to do next

  1. Please try to update your package to conform to these guidelines. The General registry's README has an FAQ that can help figure out how to do so.
  2. After you have fixed the AutoMerge issues, simply retrigger Registrator, the same way you did in the initial registration. This will automatically update this pull request. You do not need to change the version number in your Project.toml file (unless the AutoMerge issue is that you skipped a version number).

If you need help fixing the AutoMerge issues, or want your pull request to be manually merged instead, please post a comment explaining what you need help with or why you would like this pull request to be manually merged. Then, send a message to the #pkg-registration channel in the public Julia Slack for better visibility.

4. To pause or stop registration

If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text [noblock] in your comment.

Tip: You can edit blocking comments to add [noblock] in order to unblock auto-merging.

@yanjer
Copy link

yanjer commented Sep 30, 2024

There is no problem, why still can't merge, please help merge.[noblock]

@nilshg
Copy link
Contributor

nilshg commented Sep 30, 2024

Please stop spamming the registry with repeated registration requests which all fail for the same reason, and read the results of the automerge action:

I was not able to load the package (i.e. import RankMS failed). See the AutoMerge logs for details.

I.e. your package is not working. You should make sure that it actually works (you can check for yourself by adding it from GitHub and then using RankMS in a fresh Julia session) before registering a package.

Apart from that as @goerz said in one of your earlier attempts, long and descriptive package names are favoured in the Julia General registry. RankMS is not a particularly informative name, especially given that MS is not a widely used, unambiguous acronym.

@goerz
Copy link
Member

goerz commented Sep 30, 2024

Please make sure to test your package locally before registration. One thing that stands out as a potential issue is that you have a Manifest.toml file in the root of your repo. You have to delete that file.

Your src folder is quite a mess. You should really clean that up. You should only be using include statements in the main src/RankMS.jl file. In src/RankCompV3/RankCompV3.jl, you are unnecessarily using Pkg. You are also using dependencies that are not listed in your main Project.toml file. Please make sure your package only uses the absolute minimum dependencies. Remove any kind of "debugging" code. All dependencies must be listed in the [deps] section of your Project.toml, and every entry in [deps] (even standard libraries) must also have an entry in [compat] as well.

After you commit the fixes, retrigger the registration by commenting @JuliaRegistrator register on the commit in the GitHub UI. Do not change the UUID, package name, or version number. That should update this existing PR instead of creating a new one. Actually, I'm not sure how you managed to create so many registration PRs with your earlier attempts. Exactly how do you trigger these registrations?

To be honest, this package needs a major clean-up before you should try re-registering. While you're at it, I would also recommend fixing the Markdown formatting in your README. You should be using "```" for multiline code blocks.

@goerz
Copy link
Member

goerz commented Sep 30, 2024

See the AutoMerge logs for details.

@nilshg One small detail in @yanjer's favor: the "AutoMerge" step was "skipped" (presumably due to some more severe underlying issue like the presence of a Manifest.toml file). So there's not much to go on, based on the logs. That's not an ideal UX on our end.

Downloading the package and just trying to instantiate it reveals a lot of issues, though. So @yanjer should be able to sort this problems out by testing the package locally.

@GunnarFarneback
Copy link
Contributor

I believe it's more of a GitHub presentation issue. If you go to the Checks tab (at the top, together with Conversation, Commits, and Files changed) you can find the automerge job and the log saying that it failed to import the package because it tried to use Pkg without being a dependency.

Btw, having a Manifest.toml checked in is not an error. It's just not very useful.

@goerz
Copy link
Member

goerz commented Sep 30, 2024

Btw, having a Manifest.toml checked in is not an error.

Good to know! I came across this because I tried to instantiate the package after cloning it, and that gave me errors about dependencies not being in the Manifest. So at the very least, the Manifest is outdated, which seems like a bad idea ;-)

@goerz
Copy link
Member

goerz commented Sep 30, 2024

f you go to the Checks tab (at the top, together with Conversation, Commits, and Files changed) you can find the automerge job

I was not aware of this! It would probably be good to put those instructions into the bot message, where it says "See the AutoMerge logs for details." I always assumed that was referring to the list of checks at the bottom of page, but the Checks tab is much more informative!

@GunnarFarneback
Copy link
Contributor

The list at the bottom has been useful in the past, but when I look at the current set of PRs it seems somewhat random how well it correlates with the Checks tab.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants