chapel
chapel copied to clipboard
`source` field required in `Mason.toml` for registration, misleading documentation
According to masonTomlFileCheck
in masonPublish
here, the Mason.toml
file need to have a source
field in order to be registered, otherwise it fails (example 1, example 2 ).
There is no mention of this in the documentation about Manifest file and in the documentation on publishing packages it is only mentioned in the second bullet list (manual steps), letting understand that if one uses mason publish
this will be taken care of automatically (which is not the case).
A few solutions:
- Mention in the first bullet list to add manually a
source
field pointing to the repository. - ~~Let
mason publish
modify theMason.toml
to add the field if missing.~~ Wouldnt work, would still need to commit the new manifest first. - (remove the requirement, but I guess it's there for a good reason, also I see no harm in the field being there)
and a few bonus points:
- Mention the field in the documentation about
Manifest.toml
. While the field is strictly not compulsory unless one plans to publish on Mason, I think it would be good to mention there that it's good practice to have the field if you host your work in a repository, and it's needed if one wants to publish in mason - Initialize the field when running
mason new
this would require to ask for the user github account.