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

Update Chocolatey package to match current guidelines #5100

Closed
gunnarbeutner opened this issue Mar 29, 2017 · 0 comments
Closed

Update Chocolatey package to match current guidelines #5100

gunnarbeutner opened this issue Mar 29, 2017 · 0 comments
Assignees
Labels
area/setup Installation, systemd, sample files area/windows Windows agent and plugins
Milestone

Comments

@gunnarbeutner
Copy link
Contributor

Taken from https://chocolatey.org/packages/icinga2:

Guidelines

Guidelines are strong suggestions that improve the quality of a package version. These are considered something to fix for next time to increase the quality of the package. Over time Guidelines can become Requirements. A package version can be approved without addressing Guideline comments but will reduce the quality of the package.

This package uses a helper function that requires administrative permissions, the tag 'admin' should also be in the nuspec. More...

NOTE: This may become a requirement at some point.

The nuspec has been enhanced to allow packageSourceUrl, pointing to the url where the package source resides. This is a strong guideline because it simplifies collaboration. Please add it to the nuspec. More...
Release Notes (releaseNotes) are a short description of changes in each version of a package. Please include releasenotes in the nuspec. NOTE: To prevent the need to continually update this field, providing a URL to an external list of Release Notes is perfectly acceptable. More...
Write-ChocolateySuccess/Write-ChocolateyFailure have been deprecated, but have been found in the package's automation scripts. Remove the usage of those two functions. If there is an error, throw the error. More... This can also give a false positive for commented code with the words:

Write-ChocolateySuccess

Write-ChocolateyFailure

Suggestions

Suggestions are either newly introduced items that will later become Guidelines or items that are don't carry enough weight to become a Guideline. Either way they should be considered. A package version can be approved without addressing Suggestion comments.

The nuspec has been enhanced to allow more information related to the software. More... Please consider adding one or more of the following to the nuspec, if available:

docsUrl - points to the location of the wiki or docs of the software

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

bugTrackerUrl - points to the location where issues and tickets can be accessed

projectSourceUrl - points to the location of the underlying software source

Notes

Notes typically flag things for both you and the reviewer to go over. Sometimes this is the use of things that may or may not be necessary given the constraints of what you are trying to do and/or are harder for automation to flag for other reasons. Items found in Notes might be Requirements depending on the context. A package version can be approved without addressing Note comments.

Package automation scripts make use of msiexec. The reviewer will ensure there is a valid reason the package has not used the built-in helpers. More...

@gunnarbeutner gunnarbeutner added area/setup Installation, systemd, sample files area/windows Windows agent and plugins labels Mar 29, 2017
gunnarbeutner added a commit that referenced this issue Mar 30, 2017
gunnarbeutner added a commit that referenced this issue Mar 30, 2017
@gunnarbeutner gunnarbeutner self-assigned this Mar 30, 2017
@gunnarbeutner gunnarbeutner added this to the 2.6.4 milestone Mar 30, 2017
@gunnarbeutner gunnarbeutner modified the milestones: 2.6.4, 2.7.0 May 23, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/setup Installation, systemd, sample files area/windows Windows agent and plugins
Projects
None yet
Development

No branches or pull requests

1 participant