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

Fix choco package issues #37

Open
6 of 8 tasks
mp4096 opened this issue Jun 13, 2017 · 5 comments
Open
6 of 8 tasks

Fix choco package issues #37

mp4096 opened this issue Jun 13, 2017 · 5 comments
Assignees

Comments

@mp4096
Copy link
Owner

mp4096 commented Jun 13, 2017

Ok, it seems like we missed some points and have some things to do:

Easy

BTW, what's the difference between package and project source URL? We need to dig into the choco wiki.

Not so easy

Blocked

Not applicable

  • mailingListUrl - points to the forum or email list group for the software

See also https://github.com/chocolatey/package-validator/wiki/NuspecEnhancementsMissing

@mp4096 mp4096 modified the milestone: 0.5 Jun 13, 2017
mp4096 added a commit that referenced this issue Jun 14, 2017
@mp4096
Copy link
Owner Author

mp4096 commented Jun 17, 2017

Well, this is almost done. I don't think we'll have website till 0.4.1, so I'll remove the milestone for now.

@mp4096 mp4096 removed this from the 0.4.1 milestone Jun 17, 2017
@AdmiringWorm
Copy link

AdmiringWorm commented Jun 19, 2017

BTW, what's the difference between package and project source URL? We need to dig into the choco wiki.

The difference is because usually the author of the software and the maintainer of the package isn't the same, so if the software is open source, the link to the repository (or to the page where the source can be downloaded from) would be added to the projectSourceUrl.

The packageSourceUrl is the source location of the package related files only (personally I prefer that the url includes the directory the package source is located in as well).

BTW, I recommend adding some more description to the choco package as well.
Using for instance the description in the Readme.md file in this repo.

<description>
Indentex is an indentation-based superset of LaTeX. An Indentex source file is more concise and visually less cluttered than an equivalent LaTeX file. Its indentation-based syntax was inspired by Python. Transpiling an Indentex source file yields a plain LaTeX file, which can be used further in your toolchain, sent to a publisher or your colleagues.
</description>

In this case you could change to current description to be the summary instead, and then add the description I mentioned above.

BTW, the releaseNotes recommendation can be easily added by just adding a url to the Changelog file.
ie

<releaseNotes>https://github.com/mp4096/indentex/blob/master/CHANGELOG.md</releaseNotes>

@mp4096
Copy link
Owner Author

mp4096 commented Jun 22, 2017

@AdmiringWorm Thanks! We've done it exactly as you suggested.

I have to update the description, however, seems like linebreaks in XML are preserved and the description looks not so good on the Chocolatey page.

@AdmiringWorm
Copy link

@mp4096 I had a quick look at the package, and as far as I can see everything looks good (I'll now more when the automated checks have ran).

Regarding the line breaks, I should probably have mentioned that hose are preserved.
This have been mentioned to @ferventcoder in the past and most likely won't be changed anytime soon as it could affect existing package descriptions.

@mp4096
Copy link
Owner Author

mp4096 commented Jun 22, 2017

Cool!

I'm ok with line breaks, I think they're helpful when the description is long and needs to be structured.

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

No branches or pull requests

3 participants