diff --git a/.build/nugetBuild.step b/.build/nugetBuild.step index 1c99fad746..71b5417451 100644 --- a/.build/nugetBuild.step +++ b/.build/nugetBuild.step @@ -41,7 +41,8 @@ - + + diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index fce17313d4..2bfa507794 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -2,7 +2,7 @@ REPORTING A SECURITY FINDING? Stop, this is not the correct place to provide a security disclosure. -Please go to https://chocolatey.org/security for the proper disclosure process. +Please go to https://docs.chocolatey.org/en-us/information/security for the proper disclosure process. BEFORE YOU SUBMIT AN ISSUE: diff --git a/.github/ISSUE_TEMPLATE/AskQuestion.md b/.github/ISSUE_TEMPLATE/AskQuestion.md index e8d529bfe0..a2c10d7513 100644 --- a/.github/ISSUE_TEMPLATE/AskQuestion.md +++ b/.github/ISSUE_TEMPLATE/AskQuestion.md @@ -5,7 +5,7 @@ about: Do you have a question? STOP RIGHT HERE - DO NOT CREATE A TICKET FOR A QUESTION ON THIS REPOSITORY -1. Start with https://chocolatey.org/docs/troubleshooting (Troubleshooting) and https://chocolatey.org/docs/chocolatey-faqs (FAQs) to see if your question or issue already has an answer. You can also explore https://chocolatey.org/docs (which are pretty comprehensive, but not always the most searchable). +1. Start with https://docs.chocolatey.org/en-us/troubleshooting (Troubleshooting) and https://docs.chocolatey.org/en-us/faqs (FAQs) to see if your question or issue already has an answer. You can also explore https://docs.chocolatey.org/en-us/ (which are pretty comprehensive, but not always the most searchable). 2. If not found or resolved, please see https://chocolatey.org/support to see what avenues are available to you based on whether you are an open source user or a licensed customer (have a commercial edition). diff --git a/.github/ISSUE_TEMPLATE/ReportPackageIssue.md b/.github/ISSUE_TEMPLATE/ReportPackageIssue.md index 8cb2de665b..ddf94ac11e 100644 --- a/.github/ISSUE_TEMPLATE/ReportPackageIssue.md +++ b/.github/ISSUE_TEMPLATE/ReportPackageIssue.md @@ -5,14 +5,14 @@ about: Something went wrong with an installation? Want a package to be added to STOP RIGHT HERE - DO NOT CREATE A TICKET FOR PACKAGES ON THIS REPOSITORY -This is the repository for choco.exe, the command line interface for Chocolatey, and issues/feature suggestions should be limited to only choco. For a package failure, typically you would be reporting an issue with a package on the community package repository, which is not what this repository represents. In fact, the community repository and all of its packages represents about 5% of the packages in existence and less than half of the usage of choco itself. +This is the repository for choco.exe, the command line interface for Chocolatey, and issues/feature suggestions should be limited to only choco. For a package failure, typically you would be reporting an issue with a package on the community package repository, which is not what this repository represents. In fact, the community repository and all of its packages represents about 5% of the packages in existence and less than half of the usage of choco itself. In other words Chocolatey != Chocolatey.org Packages. For all things packages, you have two routes: -1. If you are having issue with a package or you want to see an enhancement, please see https://chocolatey.org/docs/package-triage-process (Package Triage Process / Becoming a maintainer of existing packages). -2. If you are looking for packages to be added to the community package repository (aka https://chocolatey.org/packages), please see https://chocolatey.org/docs/package-triage-process#package-request-package-missing (Package Requests). +1. If you are having issue with a package or you want to see an enhancement, please see https://docs.chocolatey.org/en-us/community-repository/users/package-triage-process (Package Triage Process / Becoming a maintainer of existing packages). +2. If you are looking for packages to be added to the community package repository (aka https://community.chocolatey.org/packages), please see https://docs.chocolatey.org/en-us/community-repository/users/package-triage-process#package-request-package-missing (Package Requests). diff --git a/.github/ISSUE_TEMPLATE/ReportWebsiteIssue.md b/.github/ISSUE_TEMPLATE/ReportWebsiteIssue.md index f9927c6e99..fa551b2019 100644 --- a/.github/ISSUE_TEMPLATE/ReportWebsiteIssue.md +++ b/.github/ISSUE_TEMPLATE/ReportWebsiteIssue.md @@ -1,13 +1,13 @@ --- name: Website - Report Issue / Suggest Feature -about: Something weird about https://chocolatey.org or do you want to suggest a feature? +about: Something weird about https://community.chocolatey.org or do you want to suggest a feature? --- STOP RIGHT HERE - DO NOT CREATE A TICKET FOR THE WEBSITE ON THIS REPOSITORY This is the repository for choco.exe, the command line interface for Chocolatey, and issues/feature suggestions should be limited to only choco. -For Chocolatey Gallery aka Chocolatey Community Package Repository, you will need to head over to https://github.com/chocolatey/chocolatey.org and file a ticket there. +For Chocolatey Gallery aka Chocolatey Community Package Repository, you will need to head over to https://github.com/chocolatey/home and file a ticket there. diff --git a/.github/ISSUE_TEMPLATE/SecurityDisclosure.md b/.github/ISSUE_TEMPLATE/SecurityDisclosure.md deleted file mode 100644 index 5429941268..0000000000 --- a/.github/ISSUE_TEMPLATE/SecurityDisclosure.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -name: Security Disclosure / Report -about: Found a security issue? ---- - -STOP RIGHT HERE - DO NOT CREATE A TICKET FOR A SECURITY FINDING IN THE OPEN (HERE OR IN ANY COMMUNITY) - -Security reports should never start out in the open. Please follow up directly with the team if you have a contact. If not you can always start with the information at https://chocolatey.org/security to see instructions on how to provide the disclosure. Thank you! diff --git a/.github/ISSUE_TEMPLATE/zChocoReportIssue.md b/.github/ISSUE_TEMPLATE/zChocoReportIssue.md index 121c021176..635a787ea7 100644 --- a/.github/ISSUE_TEMPLATE/zChocoReportIssue.md +++ b/.github/ISSUE_TEMPLATE/zChocoReportIssue.md @@ -3,6 +3,7 @@ name: Choco.exe - Report Issue about: Did you find unexpected behavior? --- + ## Are You In the Right Place? -Chocolatey is a large ecosystem and each component has their own location for submitting issues and enhancement requests. While the website (the community package repository) may be all your know for packages, it represents only a tiny fraction of existing packages (organizations typically maintain and host their own packages internally). This is the repository for choco.exe (the client CLI tool) for Chocolatey, which spans multiple types of environments. +Chocolatey is a large ecosystem and each component has their own location for submitting issues and enhancement requests. While the website (the community package repository) may be all you know for packages, it represents only a tiny fraction of existing packages (organizations typically maintain and host their own packages internally). This is the repository for choco.exe (the client CLI tool) for Chocolatey, which spans multiple types of environments. -Please follow this decision criteria to see if you are in the right location or if you should head to a different location to submit your request. +Please follow these decision criteria to see if you are in the right location or if you should head to a different location to submit your request. ### Reporting an Issue/Bug? -![submitting isseus](https://cloud.githubusercontent.com/assets/63502/12534440/fc223b74-c21e-11e5-9a41-1ffc1c9af48f.png) +![submitting issues](https://cloud.githubusercontent.com/assets/63502/12534440/fc223b74-c21e-11e5-9a41-1ffc1c9af48f.png) Submitting an Issue (or a Bug)? See the **[Submitting Issues](https://github.com/chocolatey/choco#submitting-issues) section** in the [README](https://github.com/chocolatey/choco/blob/master/README.md#submitting-issues). @@ -45,16 +45,16 @@ Submitting an Issue (or a Bug)? See the **[Submitting Issues](https://github.com Do not submit issues for missing `SolutionVersion.cs`. Please see [Compiling / Building Source](https://github.com/chocolatey/choco#compiling--building-source). ### Package Issue? -Please see [Request Package Fixes or Updates / Become a maintainer of an existing package](https://chocolatey.org/docs/package-triage-process). +Please see [Request Package Fixes or Updates / Become a maintainer of an existing package](https://docs.chocolatey.org/en-us/community-repository/users/package-triage-process). ### Package Request? Package Missing? -If you are looking for packages to be added to the community feed (aka https://chocolatey.org/packages), please see [Package Requests](https://chocolatey.org/docs/package-triage-process#package-request-package-missing). +If you are looking for packages to be added to the community feed (aka https://community.chocolatey.org/packages), please see [Package Requests](https://docs.chocolatey.org/en-us/community-repository/users/package-triage-process#package-request-package-missing). ### Submitting an Enhancement / Feature Request? If this is for choco (the CLI tool), this is the right place. See below. Otherwise see [Submitting Issues](https://github.com/chocolatey/choco#submitting-issues) for enhancements to the website, enhancements to the ChocolateyGUI, etc. #### Submitting an Enhancement For Choco -Log a github issue. There are less constraints on this versus reporting issues. +Log a github issue. There are fewer constraints on this versus reporting issues. ## Contributing The process for contributions is roughly as follows: @@ -62,13 +62,13 @@ The process for contributions is roughly as follows: ### Prerequisites * Submit the Enhancement ticket. You will need the issue id for your commits. * Ensure you have signed the Contributor License Agreement (CLA) - without this we are not able to take contributions that are not trivial. - * [Sign the Contributor License Agreement](https://www.clahub.com/agreements/chocolatey/choco). + * [Sign the Contributor License Agreement](https://cla-assistant.io/chocolatey/choco). * You must do this for each Chocolatey project that requires it. * If you are curious why we would require a CLA, we agree with Julien Ponge - take a look at his [post](https://julien.ponge.org/blog/in-defense-of-contributor-license-agreements/). * You agree to follow the [etiquette regarding communication](https://github.com/chocolatey/choco#etiquette-regarding-communication). #### Definition of Trivial Contributions -It's hard to define what is a trivial contribution. Sometimes even a 1 character change can be considered significant. Unfortunately because it can be subjective, the decision on what is trivial comes from the committers of the project and not from folks contributing to the project. It is generally safe to assume that you may be subject to signing the [CLA](https://www.clahub.com/agreements/chocolatey/choco) and be prepared to do so. Ask in advance if you are not sure and for reasons are not able to sign the [CLA](https://www.clahub.com/agreements/chocolatey/choco). +It's hard to define what is a trivial contribution. Sometimes even a 1 character change can be considered significant. Unfortunately because it can be subjective, the decision on what is trivial comes from the committers of the project and not from folks contributing to the project. It is generally safe to assume that you may be subject to signing the [CLA](https://cla-assistant.io/chocolatey/choco) and be prepared to do so. Ask in advance if you are not sure and for reasons are not able to sign the [CLA](https://cla-assistant.io/chocolatey/choco). What is generally considered trivial: @@ -84,7 +84,6 @@ What is generally not considered trivial: Yes, and this aspect is not up for discussion. If you would like more resources on understanding CLAs, please see the following articles: -* [What is a CLA and why do I care?](https://www.clahub.com/pages/why_cla) * [In defense of Contributor License Agreements](https://julien.ponge.org/blog/in-defense-of-contributor-license-agreements/) * [Contributor License Agreements](http://oss-watch.ac.uk/resources/cla) * Dissenting opinion - [Why your project doesn't need a Contributor License Agreement](https://sfconservancy.org/blog/2014/jun/09/do-not-need-cla/) @@ -262,7 +261,7 @@ Submitting PR: * One of the Chocolatey Team members, or one of the committers, will evaluate it within a reasonable time period (which is to say usually within 2-4 weeks). Some things get evaluated faster or fast tracked. We are human and we have active lives outside of open source so don't fret if you haven't seen any activity on your pull request within a month or two. We don't have a Service Level Agreement (SLA) for pull requests. Just know that we will evaluate your pull request. ### Respond to Feedback on Pull Request -We may have feedback for you in the form of reuqested changes or fixes. We generally like to see that pushed against the same topic branch (it will automatically update the PR). You can also fix/squash/rebase commits and push the same topic branch with `--force` (while it is generally acceptable to do this on topic branches not in the main repository, a force push should be avoided at all costs against the main repository). +We may have feedback for you in the form of requested changes or fixes. We generally like to see that pushed against the same topic branch (it will automatically update the PR). You can also fix/squash/rebase commits and push the same topic branch with `--force` (while it is generally acceptable to do this on topic branches not in the main repository, a force push should be avoided at all costs against the main repository). If we have comments or questions when we do evaluate it and receive no response, it will probably lessen the chance of getting accepted. Eventually this means it will be closed if it is not accepted. Please know this doesn't mean we don't value your contribution, just that things go stale. If in the future you want to pick it back up, feel free to address our concerns/questions/feedback and reopen the issue/open a new PR (referencing old one). diff --git a/GenerateDocs.ps1 b/GenerateDocs.ps1 index a48ab9e40f..0be09afc32 100644 --- a/GenerateDocs.ps1 +++ b/GenerateDocs.ps1 @@ -130,16 +130,16 @@ function Replace-CommonItems($text) { $text = $text.Replace("`n",$lineFeed) $text = $text -replace "\*\*NOTE:\*\*", "> :memo: **NOTE**" - $text = $text -replace '(community feed[s]?[^\]]|community repository)', '[$1](https://chocolatey.org/packages)' + $text = $text -replace '(community feed[s]?[^\]]|community repository)', '[$1](https://community.chocolatey.org/packages)' $text = $text -replace '(Chocolatey for Business|Chocolatey Professional|Chocolatey Pro)(?=[^\w])', '[$1](https://chocolatey.org/compare)' $text = $text -replace '(Pro[fessional]\s?/\s?Business)', '[$1](https://chocolatey.org/compare)' $text = $text -replace '([Ll]icensed editions)', '[$1](https://chocolatey.org/compare)' $text = $text -replace '([Ll]icensed versions)', '[$1](https://chocolatey.org/compare)' - $text = $text -replace '\(https://chocolatey.org/docs/automatic-packages\)', '(xref:automatic-packaging)' - $text = $text -replace 'Learn more about using this at https://chocolatey.org/docs/how-to-parse-package-parameters-argument', '[Learn more](xref:parse-package-parameters)' - $text = $text -replace 'at https://chocolatey.org/docs/how-to-parse-package-parameters-argument#step-3---use-core-community-extension', 'in [the docs](xref:parse-package-parameters#step-3-use-core-community-extension)' - $text = $text -replace 'https://chocolatey.org/docs/how-to-parse-package-parameters-argument', 'https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument' - $text = $text -replace '\[community feed\)\]\(https://chocolatey.org/packages\)', '[community feed](https://chocolatey.org/packages))' + $text = $text -replace '\(https://docs.chocolatey.org/en-us/create/automatic-packages\)', '(xref:automatic-packaging)' + $text = $text -replace 'Learn more about using this at https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument', '[Learn more](xref:parse-package-parameters)' + $text = $text -replace 'at https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument#step-3---use-core-community-extension', 'in [the docs](xref:parse-package-parameters#step-3-use-core-community-extension)' + $text = $text -replace 'https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument', 'https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument' + $text = $text -replace '\[community feed\)\]\(https://community.chocolatey.org/packages\)', '[community feed](https://community.chocolatey.org/packages))' Write-Output $text } @@ -222,7 +222,7 @@ param( $commandText = $commandText -replace 'NOTE\:', '> :memo: **NOTE**' $commandText = $commandText -replace '\*> :memo: \*\*NOTE\*\*\*', '> :memo: **NOTE**' $commandText = $commandText -replace 'the command reference', '[how to pass arguments](xref:choco-commands#how-to-pass-options-switches)' - $commandText = $commandText -replace '(community feed[s]?|community repository)', '[$1](https://chocolatey.org/packages)' + $commandText = $commandText -replace '(community feed[s]?|community repository)', '[$1](https://comminty.chocolatey.org/packages)' #$commandText = $commandText -replace '\`(apikey|install|upgrade|uninstall|list|search|info|outdated|pin)\`', '[[`$1`|Commands$1]]' $commandText = $commandText -replace '\`([choco\s]*)(apikey|install|upgrade|uninstall|list|search|info|outdated|pin)\`', '[`$1$2`](xref:choco-command-$2)' $commandText = $commandText -replace '^(.+):\s(.+.gif)$', '![$1]($2)' @@ -245,7 +245,7 @@ param( $commandText = $commandText -replace 'y.org/docs/features-package-reducer', 'y.org/docs/en-us/features/package-reducer' $commandText = $commandText -replace 'https://chocolatey.org/docs/features-package-reducer', 'https://docs.chocolatey.org/en-us/features/package-reducer' $commandText = $commandText -replace 'https://chocolatey.org/docs/en-us/features/package-reducer', 'https://docs.chocolatey.org/en-us/features/package-reducer' - $commandText = $commandText -replace '\[community feed\)\]\(https://chocolatey.org/packages\)', '[community feed](https://chocolatey.org/packages))' + $commandText = $commandText -replace '\[community feed\)\]\(https://community.chocolatey.org/packages\)', '[community feed](https://community.chocolatey.org/packages))' $optionsSwitches = @' ## $1 diff --git a/README.md b/README.md index 571dc55c5e..bc548d603e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ You can just call me choco. ![Chocolatey Logo](https://cdn.rawgit.com/chocolatey/choco/14a627932c78c8baaba6bef5f749ebfa1957d28d/docs/logo/chocolateyicon.gif "Chocolatey") -[![](https://img.shields.io/chocolatey/dt/chocolatey.svg)](https://chocolatey.org/packages/chocolatey) [![](https://img.shields.io/chocolatey/v/chocolatey.svg)](https://chocolatey.org/packages/chocolatey) [![](https://img.shields.io/gratipay/Chocolatey.svg)](https://www.gratipay.com/Chocolatey/) [![Project Stats](https://www.openhub.net/p/chocolatey/widgets/project_thin_badge.gif)](https://www.openhub.net/p/chocolatey) +[![](https://img.shields.io/chocolatey/dt/chocolatey.svg)](https://community.chocolatey.org/packages/chocolatey) [![](https://img.shields.io/chocolatey/v/chocolatey.svg)](https://community.chocolatey.org/packages/chocolatey) [![Project Stats](https://www.openhub.net/p/chocolatey/widgets/project_thin_badge.gif)](https://www.openhub.net/p/chocolatey) @@ -60,14 +60,14 @@ If you are an open source user requesting support, please remember that most fol If you are using a [commercial edition of Chocolatey](https://chocolatey.org/compare#compare), you have different terms! Please see [support](https://chocolatey.org/support). ## Information - * [Chocolatey Website and Community Package Repository](https://chocolatey.org) + * [Chocolatey Website and Community Package Repository](https://community.chocolatey.org) * [Mailing List](http://groups.google.com/group/chocolatey) / [Release Announcements Only Mailing List](https://groups.google.com/group/chocolatey-announce) / [Build Status Mailing List](http://groups.google.com/group/chocolatey-build-status) * [Twitter](https://twitter.com/chocolateynuget) / [Facebook](https://www.facebook.com/ChocolateySoftware) / [Github](https://github.com/chocolatey) - * [Blog](https://chocolatey.org/blog) / [Newsletter](https://chocolatey.us8.list-manage1.com/subscribe?u=86a6d80146a0da7f2223712e4&id=73b018498d) - * [Documentation](https://chocolatey.org/docs) / [Support](https://chocolatey.org/support) + * [Blog](https://blog.chocolatey.org/) / [Newsletter](https://chocolatey.us8.list-manage1.com/subscribe?u=86a6d80146a0da7f2223712e4&id=73b018498d) + * [Documentation](https://docs.chocolatey.org/en-us/) / [Support](https://chocolatey.org/support) ### Documentation -Please see the [docs](https://chocolatey.org/docs) +Please see the [docs](https://docs.chocolatey.org/en-us/) Give `choco.exe -?` a shot (or `choco.exe -h`). For specific commands, add the command and then the help switch e.g. `choco.exe install -h`. @@ -82,13 +82,13 @@ Apache 2.0 - see [LICENSE](https://github.com/chocolatey/choco/blob/master/LICEN ## Submitting Issues ![submitting issues](https://cloud.githubusercontent.com/assets/63502/12534554/6ea7cc04-c224-11e5-82ad-3805d0b5c724.png) - * If you are having issue with a package, please see [Request Package Fixes or Updates / Become a maintainer of an existing package](https://chocolatey.org/docs/package-triage-process). - * If you are looking for packages to be added to the community feed (aka https://chocolatey.org/packages), please see [Package Requests](https://chocolatey.org/docs/package-triage-process#package-request-package-missing). + * If you are having issue with a package, please see [Request Package Fixes or Updates / Become a maintainer of an existing package](https://docs.chocolatey.org/en-us/community-repository/users/package-triage-process). + * If you are looking for packages to be added to the community feed (aka https://community.chocolatey.org/packages), please see [Package Requests](https://docs.chocolatey.org/en-us/community-repository/users/package-triage-process#package-request-package-missing). 1. Start with [Troubleshooting](https://github.com/chocolatey/choco/wiki/Troubleshooting) and the [FAQ](https://github.com/chocolatey/choco/wiki/ChocolateyFAQs) to see if your question or issue already has an answer. 1. If not found or resolved, please follow one of the following avenues: * If you are a licensed customer, please see [support](https://chocolatey.org/support). You can also log an issue to [Licensed Issues](https://github.com/chocolatey/chocolatey-licensed-issues) and we will submit issues to all other places on your behalf. Another avenue is to use email support to have us submit tickets and other avenues on your behalf (allowing you to maintain privacy). - * If it is an enhancement request or issue with the website (the community package repository aka [https://chocolatey.org](https://chocolatey.org)), please submit the issue to the [Chocolatey.org repo](https://github.com/chocolatey/chocolatey.org). + * If it is an enhancement request or issue with the website (the community package repository aka [https://community.chocolatey.org](https://community.chocolatey.org)), please submit the issue to the [Chocolatey.org repo](https://github.com/chocolatey/home). * If you have found an issue with the GUI (Chocolatey GUI) or you want to submit an enhancement, please see [the ChocolateyGUI repository](https://github.com/chocolatey/ChocolateyGUI#submitting-issues). * If you have found an issue with the client (choco.exe), you are in the right place. Keep reading below. @@ -124,6 +124,7 @@ There is a `build.bat`/`build.sh` file that creates a necessary generated file n #### Windows Prerequisites: + * .NET Framework 3.5 (This is a windows feature installation). * .NET Framework 4+ * Visual Studio is helpful for working on source. * ReSharper is immensely helpful (and there is a `.sln.DotSettings` file to help with code conventions). @@ -190,7 +191,7 @@ yum install mono-devel -y ``` * [Fedora](https://www.mono-project.com/download/stable/#download-lin-fedora) - + ```sh ### NOT FULLY TESTED AND WORKING ### diff --git a/docker/Dockerfile.linux b/docker/Dockerfile.linux index 24754056ba..54bbc9ec19 100644 --- a/docker/Dockerfile.linux +++ b/docker/Dockerfile.linux @@ -2,6 +2,8 @@ FROM mono:5.20.1.19 MAINTAINER Justin Phelps +RUN apt-get update && apt-get install git -y + COPY . /usr/local/src/choco/ WORKDIR /usr/local/src/choco diff --git a/docs/legal/CREDITS.md b/docs/legal/CREDITS.md index 86a932656f..20b4a0df99 100644 --- a/docs/legal/CREDITS.md +++ b/docs/legal/CREDITS.md @@ -43,7 +43,6 @@ The Chocolatey Community Team includes the committers and adds these fine folks: ### Contributors * [choco.exe](https://github.com/chocolatey/choco/graphs/contributors) * [Original Chocolatey - POSH choco](https://github.com/chocolatey/chocolatey/graphs/contributors) - * [Community Package Repository / Chocolatey.org](https://github.com/chocolatey/chocolatey.org/graphs/contributors) ### Other Contributors **NOTE: NEEDS UPDATED** diff --git a/nuget/chocolatey.lib/chocolatey.lib.nuspec b/nuget/chocolatey.lib/chocolatey.lib.nuspec index ddc8cdc32a..9ccb45a197 100644 --- a/nuget/chocolatey.lib/chocolatey.lib.nuspec +++ b/nuget/chocolatey.lib/chocolatey.lib.nuspec @@ -24,11 +24,11 @@ This is the Chocolatey Library (API / DLL) package which allows Chocolatey to be ### Information - * [Chocolatey Website and Community Package Repository](https://chocolatey.org) + * [Chocolatey Website and Community Package Repository](https://community.chocolatey.org) * [Mailing List](http://groups.google.com/group/chocolatey) / [Release Announcements Only Mailing List](https://groups.google.com/group/chocolatey-announce) / [Build Status Mailing List](http://groups.google.com/group/chocolatey-build-status) * [Twitter](https://twitter.com/chocolateynuget) / [Facebook](https://www.facebook.com/ChocolateySoftware) / [Github](https://github.com/chocolatey) - * [Blog](https://chocolatey.org/blog) / [Newsletter](https://chocolatey.us8.list-manage1.com/subscribe?u=86a6d80146a0da7f2223712e4&id=73b018498d) - * [Documentation](https://chocolatey.org/docs) / [Support](https://chocolatey.org/support) + * [Blog](https://blog.chocolatey.org/) / [Newsletter](https://chocolatey.us8.list-manage1.com/subscribe?u=86a6d80146a0da7f2223712e4&id=73b018498d) + * [Documentation](https://docs.chocolatey.org/en-us/) / [Support](https://chocolatey.org/support) See all - https://github.com/chocolatey/choco/blob/stable/CHANGELOG.md diff --git a/nuget/chocolatey/chocolatey.nuspec b/nuget/chocolatey/chocolatey.nuspec index 398e4e4e4c..40f4d05805 100644 --- a/nuget/chocolatey/chocolatey.nuspec +++ b/nuget/chocolatey/chocolatey.nuspec @@ -13,7 +13,7 @@ false 2017-2019 Chocolatey Software, Inc, 2011- 2017 RealDimensions Software, LLC nuget apt-get machine repository chocolatey @@ -27,14 +27,14 @@ You can host your own sources and add them to Chocolatey, you can extend Chocola ### Information - * [Chocolatey Website and Community Package Repository](https://chocolatey.org) + * [Chocolatey Website and Community Package Repository](https://community.chocolatey.org) * [Mailing List](http://groups.google.com/group/chocolatey) / [Release Announcements Only Mailing List](https://groups.google.com/group/chocolatey-announce) / [Build Status Mailing List](http://groups.google.com/group/chocolatey-build-status) * [Twitter](https://twitter.com/chocolateynuget) / [Facebook](https://www.facebook.com/ChocolateySoftware) / [Github](https://github.com/chocolatey) - * [Blog](https://chocolatey.org/blog) / [Newsletter](https://chocolatey.us8.list-manage1.com/subscribe?u=86a6d80146a0da7f2223712e4&id=73b018498d) - * [Documentation](https://chocolatey.org/docs) / [Support](https://chocolatey.org/support) + * [Blog](https://blog.chocolatey.org/) / [Newsletter](https://chocolatey.us8.list-manage1.com/subscribe?u=86a6d80146a0da7f2223712e4&id=73b018498d) + * [Documentation](https://docs.chocolatey.org/en-us/) / [Support](https://chocolatey.org/support) ### Commands -There are quite a few commands you can call - you should check out the [command reference](https://chocolatey.org/docs/commands-reference). Here are the most common: +There are quite a few commands you can call - you should check out the [command reference](https://docs.chocolatey.org/en-us/choco/commands). Here are the most common: * Help - choco -? or choco command -? * Search - choco search something @@ -53,12 +53,12 @@ There are quite a few commands you can call - you should check out the [command * Install webpi feature - choco install IIS7.5Express -source webpi #### More -For more advanced commands and switches, use `choco -?` or `choco command -h`. You can also look at the [command reference](https://chocolatey.org/docs/commands-reference), including how you can force a package to install the x86 version of a package. +For more advanced commands and switches, use `choco -?` or `choco command -h`. You can also look at the [command reference](https://docs.chocolatey.org/en-us/choco/commands), including how you can force a package to install the x86 version of a package. ### Create Packages? -We have some great guidance on how to do that. Where? I'll give you a hint, it rhymes with socks! [Docs!](https://chocolatey.org/docs/create-packages) +We have some great guidance on how to do that. Where? I'll give you a hint, it rhymes with socks! [Docs!](https://docs.chocolatey.org/en-us/create/create-packages) -In that mess there is a link to the [PowerShell Chocolatey module reference](https://chocolatey.org/docs/helpers-reference). +In that mess there is a link to the [PowerShell Chocolatey module reference](https://docs.chocolatey.org/en-us/create/functions). See all - https://github.com/chocolatey/choco/blob/stable/CHANGELOG.md diff --git a/setup.ps1 b/setup.ps1 index 17b80ad72e..9ed7de8713 100644 --- a/setup.ps1 +++ b/setup.ps1 @@ -1,6 +1,6 @@ ### install chocolatey ### if(-not $env:ChocolateyInstall -or -not (Test-Path "$env:ChocolateyInstall")){ - iex ((new-object net.webclient).DownloadString("https://chocolatey.org/install.ps1")) + iex ((new-object net.webclient).DownloadString("https://community.chocolatey.org/install.ps1")) } cinst pester -version 2.0.2 diff --git a/src/chocolatey.resources/helpers/functions/Get-CheckSumValid.ps1 b/src/chocolatey.resources/helpers/functions/Get-CheckSumValid.ps1 index 1e31fc3ee6..b64da7c06c 100644 --- a/src/chocolatey.resources/helpers/functions/Get-CheckSumValid.ps1 +++ b/src/chocolatey.resources/helpers/functions/Get-CheckSumValid.ps1 @@ -45,7 +45,7 @@ to what is expected. .NOTES This uses the checksum.exe tool available separately at -https://chocolatey.org/packages/checksum. +https://community.chocolatey.org/packages/checksum. Options that affect checksum verification: @@ -85,12 +85,12 @@ and a moderator (if applicable), plus any moderation review has intended for you to receive with this package. If you are looking at a remote source that uses the same url for updates, you will need to ensure the package also stays updated in line with those remote -resource updates. You should look into [automatic packaging](https://chocolatey.org/docs/automatic-packages) +resource updates. You should look into [automatic packaging](https://docs.chocolatey.org/en-us/create/automatic-packages) to help provide that functionality. **NOTE:** To determine checksums, you can get that from the original site if provided. You can also use the [checksum tool available on -the community feed](https://chocolatey.org/packages/checksum) (`choco install checksum`) +the community feed](https://community.chocolatey.org/packages/checksum) (`choco install checksum`) and use it e.g. `checksum -t sha256 -f path\to\file`. Ensure you provide checksums for all remote resources used. @@ -146,7 +146,7 @@ param( Write-Warning "Missing package checksums are not allowed (by default for HTTP/FTP, `n HTTPS when feature 'allowEmptyChecksumsSecure' is disabled) for `n safety and security reasons. Although we strongly advise against it, `n if you need this functionality, please set the feature `n 'allowEmptyChecksums' ('choco feature enable -n `n allowEmptyChecksums') `n or pass in the option '--allow-empty-checksums'. You can also pass `n checksums at runtime (recommended). See `choco install -?` for details." Write-Debug "If you are a maintainer attempting to determine the checksum for packaging purposes, please run `n 'choco install checksum' and run 'checksum -t sha256 -f $file' `n Ensure you do this for all remote resources." - if ($PSVersionTable.PSVersion.Major -ge 4){ + if ($PSVersionTable.PSVersion.Major -ge 4){ Write-Debug "Because you are running Powershell with a major version of v4 or greater, you could also opt to run `n '(Get-FileHash -Path $file -Algorithm SHA256).Hash' `n rather than install a separate tool." } diff --git a/src/chocolatey.resources/helpers/functions/Get-ChocolateyWebFile.ps1 b/src/chocolatey.resources/helpers/functions/Get-ChocolateyWebFile.ps1 index 4141bd36cf..3533e26ff1 100644 --- a/src/chocolatey.resources/helpers/functions/Get-ChocolateyWebFile.ps1 +++ b/src/chocolatey.resources/helpers/functions/Get-ChocolateyWebFile.ps1 @@ -76,7 +76,7 @@ and a moderator (if applicable), plus any moderation review has intended for you to receive with this package. If you are looking at a remote source that uses the same url for updates, you will need to ensure the package also stays updated in line with those remote -resource updates. You should look into [automatic packaging](https://chocolatey.org/docs/automatic-packages) +resource updates. You should look into [automatic packaging](https://docs.chocolatey.org/en-us/create/automatic-packages) to help provide that functionality. .PARAMETER ChecksumType @@ -103,12 +103,12 @@ and a moderator (if applicable), plus any moderation review has intended for you to receive with this package. If you are looking at a remote source that uses the same url for updates, you will need to ensure the package also stays updated in line with those remote -resource updates. You should look into [automatic packaging](https://chocolatey.org/docs/automatic-packages) +resource updates. You should look into [automatic packaging](https://docs.chocolatey.org/en-us/create/automatic-packages) to help provide that functionality. **NOTE:** To determine checksums, you can get that from the original site if provided. You can also use the [checksum tool available on -the community feed](https://chocolatey.org/packages/checksum) (`choco install checksum`) +the community feed](https://community.chocolatey.org/packages/checksum) (`choco install checksum`) and use it e.g. `checksum -t sha256 -f path\to\file`. Ensure you provide checksums for all remote resources used. diff --git a/src/chocolatey.resources/helpers/functions/Get-FtpFile.ps1 b/src/chocolatey.resources/helpers/functions/Get-FtpFile.ps1 index 61cc1ff93d..731d97edd1 100644 --- a/src/chocolatey.resources/helpers/functions/Get-FtpFile.ps1 +++ b/src/chocolatey.resources/helpers/functions/Get-FtpFile.ps1 @@ -192,7 +192,7 @@ param( Set-PowerShellExitCode 404 if ($env:DownloadCacheAvailable -eq 'true') { - throw "The remote file either doesn't exist, is unauthorized, or is forbidden for url '$url'. $($_.Exception.Message) `nThis package is likely not broken for licensed users - see https://chocolatey.org/docs/features-private-cdn." + throw "The remote file either doesn't exist, is unauthorized, or is forbidden for url '$url'. $($_.Exception.Message) `nThis package is likely not broken for licensed users - see https://docs.chocolatey.org/en-us/features/private-cdn." } else { throw "The remote file either doesn't exist, is unauthorized, or is forbidden for url '$url'. $($_.Exception.Message)" } diff --git a/src/chocolatey.resources/helpers/functions/Get-PackageParameters.ps1 b/src/chocolatey.resources/helpers/functions/Get-PackageParameters.ps1 index 7553abd2b4..f70fce0e81 100644 --- a/src/chocolatey.resources/helpers/functions/Get-PackageParameters.ps1 +++ b/src/chocolatey.resources/helpers/functions/Get-PackageParameters.ps1 @@ -34,15 +34,15 @@ use in package scripts. By default this will look at (`--package-parameters-sensitive="'/PASSWORD:value'"` in commercial editions). -Learn more about using this at https://chocolatey.org/docs/how-to-parse-package-parameters-argument +Learn more about using this at https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument .NOTES Available in 0.10.8+. If you need compatibility with older versions, take a dependency on the `chocolatey-core.extension` package which also provides this functionality. If you are pushing to the community -package repository (https://chocolatey.org/packages), you are required +package repository (https://community.chocolatey.org/packages), you are required to take a dependency on the core extension until January 2018. How to -do this is explained at https://chocolatey.org/docs/how-to-parse-package-parameters-argument#step-3---use-core-community-extension. +do this is explained at https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument#step-3---use-core-community-extension. The differences between this and the `chocolatey-core.extension` package functionality is that the extension function can only do one string at a @@ -86,7 +86,7 @@ $pp = Get-PackageParameters .EXAMPLE > -# see https://chocolatey.org/docs/how-to-parse-package-parameters-argument +# see https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument # command line call: `choco install --params "'/LICENSE:value'"` $pp = Get-PackageParameters # Read-Host, PromptForChoice, etc are not blocking calls with Chocolatey. diff --git a/src/chocolatey.resources/helpers/functions/Get-WebFile.ps1 b/src/chocolatey.resources/helpers/functions/Get-WebFile.ps1 index 9a33819119..5bcb20c6cc 100644 --- a/src/chocolatey.resources/helpers/functions/Get-WebFile.ps1 +++ b/src/chocolatey.resources/helpers/functions/Get-WebFile.ps1 @@ -131,7 +131,7 @@ param( $passwd = ConvertTo-SecureString $explicitProxyPassword -AsPlainText -Force $proxy.Credentials = New-Object System.Management.Automation.PSCredential ($explicitProxyUser, $passwd) } - + if ($explicitProxyBypassList -ne $null -and $explicitProxyBypassList -ne '') { $proxy.BypassList = $explicitProxyBypassList.Split(',', [System.StringSplitOptions]::RemoveEmptyEntries) } @@ -326,7 +326,7 @@ param( Set-PowerShellExitCode 404 if ($env:DownloadCacheAvailable -eq 'true') { - throw "The remote file either doesn't exist, is unauthorized, or is forbidden for url '$url'. $($_.Exception.Message) `nThis package is likely not broken for licensed users - see https://chocolatey.org/docs/features-private-cdn." + throw "The remote file either doesn't exist, is unauthorized, or is forbidden for url '$url'. $($_.Exception.Message) `nThis package is likely not broken for licensed users - see https://docs.chocolatey.org/en-us/features/private-cdn." } else { throw "The remote file either doesn't exist, is unauthorized, or is forbidden for url '$url'. $($_.Exception.Message)" } diff --git a/src/chocolatey.resources/helpers/functions/Install-ChocolateyPackage.ps1 b/src/chocolatey.resources/helpers/functions/Install-ChocolateyPackage.ps1 index 1592bf09f5..9131d0f2b3 100644 --- a/src/chocolatey.resources/helpers/functions/Install-ChocolateyPackage.ps1 +++ b/src/chocolatey.resources/helpers/functions/Install-ChocolateyPackage.ps1 @@ -143,12 +143,12 @@ and a moderator (if applicable), plus any moderation review has intended for you to receive with this package. If you are looking at a remote source that uses the same url for updates, you will need to ensure the package also stays updated in line with those remote -resource updates. You should look into [automatic packaging](https://chocolatey.org/docs/automatic-packages) +resource updates. You should look into [automatic packaging](https://docs.chocolatey.org/en-us/create/automatic-packages) to help provide that functionality. **NOTE:** To determine checksums, you can get that from the original site if provided. You can also use the [checksum tool available on -the community feed](https://chocolatey.org/packages/checksum) (`choco install checksum`) +the community feed](https://community.chocolatey.org/packages/checksum) (`choco install checksum`) and use it e.g. `checksum -t sha256 -f path\to\file`. Ensure you provide checksums for all remote resources used. @@ -176,7 +176,7 @@ and a moderator (if applicable), plus any moderation review has intended for you to receive with this package. If you are looking at a remote source that uses the same url for updates, you will need to ensure the package also stays updated in line with those remote -resource updates. You should look into [automatic packaging](https://chocolatey.org/docs/automatic-packages) +resource updates. You should look into [automatic packaging](https://docs.chocolatey.org/en-us/create/automatic-packages) to help provide that functionality. .PARAMETER ChecksumType64 diff --git a/src/chocolatey.resources/helpers/functions/Install-ChocolateyPowershellCommand.ps1 b/src/chocolatey.resources/helpers/functions/Install-ChocolateyPowershellCommand.ps1 index 13f7aff0a7..5eddd3e0b2 100644 --- a/src/chocolatey.resources/helpers/functions/Install-ChocolateyPowershellCommand.ps1 +++ b/src/chocolatey.resources/helpers/functions/Install-ChocolateyPowershellCommand.ps1 @@ -86,7 +86,7 @@ and a moderator (if applicable), plus any moderation review has intended for you to receive with this package. If you are looking at a remote source that uses the same url for updates, you will need to ensure the package also stays updated in line with those remote -resource updates. You should look into [automatic packaging](https://chocolatey.org/docs/automatic-packages) +resource updates. You should look into [automatic packaging](https://docs.chocolatey.org/en-us/create/automatic-packages) to help provide that functionality. .PARAMETER ChecksumType @@ -113,12 +113,12 @@ and a moderator (if applicable), plus any moderation review has intended for you to receive with this package. If you are looking at a remote source that uses the same url for updates, you will need to ensure the package also stays updated in line with those remote -resource updates. You should look into [automatic packaging](https://chocolatey.org/docs/automatic-packages) +resource updates. You should look into [automatic packaging](https://docs.chocolatey.org/en-us/create/automatic-packages) to help provide that functionality. **NOTE:** To determine checksums, you can get that from the original site if provided. You can also use the [checksum tool available on -the community feed](https://chocolatey.org/packages/checksum) (`choco install checksum`) +the community feed](https://community.chocolatey.org/packages/checksum) (`choco install checksum`) and use it e.g. `checksum -t sha256 -f path\to\file`. Ensure you provide checksums for all remote resources used. diff --git a/src/chocolatey.resources/helpers/functions/Install-ChocolateyVsixPackage.ps1 b/src/chocolatey.resources/helpers/functions/Install-ChocolateyVsixPackage.ps1 index 04737fa8fe..821d6bb704 100644 --- a/src/chocolatey.resources/helpers/functions/Install-ChocolateyVsixPackage.ps1 +++ b/src/chocolatey.resources/helpers/functions/Install-ChocolateyVsixPackage.ps1 @@ -66,26 +66,26 @@ by looking at the folders under Program Files / Program Files (x86). In 0.10.4+, `VisualStudioVersion` is an alias for VsVersion. .PARAMETER Checksum -The checksum hash value of the Url resource. This allows a checksum to +The checksum hash value of the Url resource. This allows a checksum to be validated for files that are not local. The checksum type is covered -by ChecksumType. +by ChecksumType. -**NOTE:** Checksums in packages are meant as a measure to validate the +**NOTE:** Checksums in packages are meant as a measure to validate the originally intended file that was used in the creation of a package is the same file that is received at a future date. Since this is used for -other steps in the process related to the community repository, it +other steps in the process related to the community repository, it ensures that the file a user receives is the same file a maintainer -and a moderator (if applicable), plus any moderation review has -intended for you to receive with this package. If you are looking at a -remote source that uses the same url for updates, you will need to -ensure the package also stays updated in line with those remote -resource updates. You should look into [automatic packaging](https://chocolatey.org/docs/automatic-packages) +and a moderator (if applicable), plus any moderation review has +intended for you to receive with this package. If you are looking at a +remote source that uses the same url for updates, you will need to +ensure the package also stays updated in line with those remote +resource updates. You should look into [automatic packaging](https://docs.chocolatey.org/en-us/create/automatic-packages) to help provide that functionality. -**NOTE:** To determine checksums, you can get that from the original -site if provided. You can also use the [checksum tool available on -the community feed](https://chocolatey.org/packages/checksum) (`choco install checksum`) -and use it e.g. `checksum -t sha256 -f path\to\file`. Ensure you +**NOTE:** To determine checksums, you can get that from the original +site if provided. You can also use the [checksum tool available on +the community feed](https://community.chocolatey.org/packages/checksum) (`choco install checksum`) +and use it e.g. `checksum -t sha256 -f path\to\file`. Ensure you provide checksums for all remote resources used. .PARAMETER ChecksumType diff --git a/src/chocolatey.resources/helpers/functions/Install-ChocolateyZipPackage.ps1 b/src/chocolatey.resources/helpers/functions/Install-ChocolateyZipPackage.ps1 index e6c0fc8a44..8404fdd454 100644 --- a/src/chocolatey.resources/helpers/functions/Install-ChocolateyZipPackage.ps1 +++ b/src/chocolatey.resources/helpers/functions/Install-ChocolateyZipPackage.ps1 @@ -85,12 +85,12 @@ and a moderator (if applicable), plus any moderation review has intended for you to receive with this package. If you are looking at a remote source that uses the same url for updates, you will need to ensure the package also stays updated in line with those remote -resource updates. You should look into [automatic packaging](https://chocolatey.org/docs/automatic-packages) +resource updates. You should look into [automatic packaging](https://docs.chocolatey.org/en-us/create/automatic-packages) to help provide that functionality. **NOTE:** To determine checksums, you can get that from the original site if provided. You can also use the [checksum tool available on -the community feed](https://chocolatey.org/packages/checksum) (`choco install checksum`) +the community feed](https://community.chocolatey.org/packages/checksum) (`choco install checksum`) and use it e.g. `checksum -t sha256 -f path\to\file`. Ensure you provide checksums for all remote resources used. @@ -118,7 +118,7 @@ and a moderator (if applicable), plus any moderation review has intended for you to receive with this package. If you are looking at a remote source that uses the same url for updates, you will need to ensure the package also stays updated in line with those remote -resource updates. You should look into [automatic packaging](https://chocolatey.org/docs/automatic-packages) +resource updates. You should look into [automatic packaging](https://docs.chocolatey.org/en-us/create/automatic-packages) to help provide that functionality. .PARAMETER ChecksumType64 @@ -203,7 +203,7 @@ param( if ($url -eq '' -or $url -eq $null) { $url = $file - } + } if ($url64bit -eq '' -or $url64bit -eq $null) { $url64bit = $file64 } diff --git a/src/chocolatey/infrastructure.app/ApplicationParameters.cs b/src/chocolatey/infrastructure.app/ApplicationParameters.cs index 8a39f7606a..1385dc9924 100644 --- a/src/chocolatey/infrastructure.app/ApplicationParameters.cs +++ b/src/chocolatey/infrastructure.app/ApplicationParameters.cs @@ -89,7 +89,7 @@ public static class ApplicationParameters public static readonly string TemplatesLocation = _fileSystem.combine_paths(InstallLocation, "templates"); public static readonly string ChocolateyCommunityFeedPushSourceOld = "https://chocolatey.org/"; public static readonly string ChocolateyCommunityFeedPushSource = "https://push.chocolatey.org/"; - public static readonly string ChocolateyCommunityFeedSource = "https://chocolatey.org/api/v2/"; + public static readonly string ChocolateyCommunityFeedSource = "https://community.chocolatey.org/api/v2/"; public static readonly string ChocolateyLicensedFeedSource = "https://licensedpackages.chocolatey.org/api/v2/"; public static readonly string ChocolateyLicensedFeedSourceName = "chocolatey.licensed"; public static readonly string UserAgent = "Chocolatey Command Line"; diff --git a/src/chocolatey/infrastructure.app/builders/ConfigurationBuilder.cs b/src/chocolatey/infrastructure.app/builders/ConfigurationBuilder.cs index 184e033be4..2f30fda2fa 100644 --- a/src/chocolatey/infrastructure.app/builders/ConfigurationBuilder.cs +++ b/src/chocolatey/infrastructure.app/builders/ConfigurationBuilder.cs @@ -477,7 +477,7 @@ the local options are parsed. (`""value""`) but in powershell.exe you should use backticks (`` `""value`"" ``) or apostrophes (`'value'`). Using the combination allows for both shells to work without issue, except for when the next - section applies. + section applies. * **Pass quotes in arguments**: When you need to pass quoted values to to something like a native installer, you are in for a world of fun. In cmd.exe you must pass it like this: `-ia ""/yo=""""Spaces spaces""""""`. In @@ -499,32 +499,32 @@ wanting to pass specific options. When writing scripts, such as PowerShell scripts passing options and switches, there are some best practices to follow to ensure that you don't run into issues later. This also applies to integrations that -are calling Chocolatey and parsing output. Chocolatey **uses** +are calling Chocolatey and parsing output. Chocolatey **uses** PowerShell, but it is an exe, so it cannot return PowerShell objects. -Following these practices ensures both readability of your scripts AND -compatibility across different versions and editions of Chocolatey. -Following this guide will ensure your experience is not frustrating +Following these practices ensures both readability of your scripts AND +compatibility across different versions and editions of Chocolatey. +Following this guide will ensure your experience is not frustrating based on choco not receiving things you think you are passing to it. - * For consistency, always use `choco`, not `choco.exe`. Never use + * For consistency, always use `choco`, not `choco.exe`. Never use shortcut commands like `cinst` or `cup`. * Always have the command as the first argument to `choco`. e.g. `choco install`, where `install` is the command. * If there is a subcommand, ensure that is the second argument. e.g. `choco source list`, where `source` is the command and `list` is the subcommand. - * Typically the subject comes next. If installing packages, the + * Typically the subject comes next. If installing packages, the subject would be the package names, e.g. `choco install pkg1 pkg2`. * Never use 'nupkg' or point directly to a nupkg file UNLESS using 'choco push'. Use the source folder instead, e.g. `choco install - --source=""'c:\folder\with\package'""` instead of - `choco install DoNotDoThis.1.0.nupkg` or `choco install DoNotDoThis + --source=""'c:\folder\with\package'""` instead of + `choco install DoNotDoThis.1.0.nupkg` or `choco install DoNotDoThis --source=""'c:\folder\with\package\DoNotDoThis.1.0.nupkg'""`. - * Switches and parameters are called simply options. Options come + * Switches and parameters are called simply options. Options come after the subject. e.g. `choco install pkg1 --debug --verbose`. * Never use the force option (`--force`/`-f`) in scripts (or really - otherwise as a default mode of use). Force is an override on + otherwise as a default mode of use). Force is an override on Chocolatey behavior. If you are wondering why Chocolatey isn't doing something like the documentation says it should, it's likely because you are using force. Stop. @@ -532,60 +532,60 @@ Chocolatey behavior. If you are wondering why Chocolatey isn't doing full option is `--name`, use `--name`. The only acceptable short option for use in scripts is `-y`. Find option names in help docs online or through `choco -?` /`choco [Command Name] -?`. - * For scripts that are running automated, always use `-y`. Do note + * For scripts that are running automated, always use `-y`. Do note that even with `-y` passed, some things / state issues detected will - temporarily stop for input - the key here is temporarily. They will + temporarily stop for input - the key here is temporarily. They will continue without requiring any action after the temporary timeout (typically 30 seconds). - * Full option names are prepended with two dashes, e.g. `--` or + * Full option names are prepended with two dashes, e.g. `--` or `--debug --verbose --ignore-proxy`. - * When setting a value to an option, always put an equals (`=`) + * When setting a value to an option, always put an equals (`=`) between the name and the setting, e.g. `--source=""'local'""`. - * When setting a value to an option, always surround the value - properly with double quotes bookending apostrophes, e.g. + * When setting a value to an option, always surround the value + properly with double quotes bookending apostrophes, e.g. `--source=""'internal_server'""`. - * If you are building PowerShell scripts, you can most likely just - simply use apostrophes surrounding option values, e.g. + * If you are building PowerShell scripts, you can most likely just + simply use apostrophes surrounding option values, e.g. `--source='internal_server'`. * Prefer upgrade to install in scripts. You can't `install` to a newer version of something, but you can `choco upgrade` which will do both upgrade or install (unless switched off explicitly). - * If you are sharing the script with others, pass `--source` to be - explicit about where the package is coming from. Use full link and - not source name ('https://chocolatey.org/api/v2' versus + * If you are sharing the script with others, pass `--source` to be + explicit about where the package is coming from. Use full link and + not source name ('https://community.chocolatey.org/api/v2/' versus 'chocolatey'). - * If parsing output, you might want to use `--limit-output`/`-r` to - get output in a more machine parseable format. NOTE: Not all - commands handle return of information in an easily digestible + * If parsing output, you might want to use `--limit-output`/`-r` to + get output in a more machine parseable format. NOTE: Not all + commands handle return of information in an easily digestible output. - * Use exit codes to determine status. Chocolatey exits with 0 when - everything worked appropriately and other exits codes like 1 when - things error. There are package specific exit codes that are + * Use exit codes to determine status. Chocolatey exits with 0 when + everything worked appropriately and other exits codes like 1 when + things error. There are package specific exit codes that are recommended to be used and reboot indicating exit codes as well. To - check exit code when using PowerShell, immediately call + check exit code when using PowerShell, immediately call `$exitCode = $LASTEXITCODE` to get the value choco exited with. -Here's an example following bad practices (line breaks added for +Here's an example following bad practices (line breaks added for readability): - `choco install pkg1 -y -params '/Option:Value /Option2:value with + `choco install pkg1 -y -params '/Option:Value /Option2:value with spaces' --c4b-option 'Yaass' --option-that-is-new 'dude upgrade'` -Now here is that example written with best practices (again line - breaks added for readability - there are not line continuations +Now here is that example written with best practices (again line + breaks added for readability - there are not line continuations for choco): - `choco upgrade pkg1 -y --source=""'https://chocolatey.org/api/v2'"" + `choco upgrade pkg1 -y --source=""'https://community.chocolatey.org/api/v2/'"" --package-parameters=""'/Option:Value /Option2:value with spaces'"" --c4b-option=""'Yaass'"" --option-that-is-new=""'dude upgrade'""` -Note the differences between the two: - * Which is more self-documenting? - * Which will allow for the newest version of something installed or +Note the differences between the two: + * Which is more self-documenting? + * Which will allow for the newest version of something installed or upgraded to (which allows for more environmental consistency on packages and versions)? * Which may throw an error on a badly passed option? - * Which will throw errors on unknown option values? See explanation + * Which will throw errors on unknown option values? See explanation below. Chocolatey ignores options it doesn't understand, but it can only @@ -594,8 +594,8 @@ equals sign ('='). Note those last two options in the examples above? If you roll off of a commercial edition or someone with older version attempts to run the badly crafted script `--c4b-option 'Yaass' --option-that-is-new 'dude upgrade'`, they are likely to see errors on - 'Yaass' and 'dude upgrade' because they are not explicitly tied to the - option they are written after. Now compare that to the other script. + 'Yaass' and 'dude upgrade' because they are not explicitly tied to the + option they are written after. Now compare that to the other script. Choco will ignore `--c4b-option=""'Yaass'""` and `--option-that-is-new=""'dude upgrade'""` as a whole when it doesn't register the options. This means that your script doesn't error. diff --git a/src/chocolatey/infrastructure.app/commands/ChocolateyApiKeyCommand.cs b/src/chocolatey/infrastructure.app/commands/ChocolateyApiKeyCommand.cs index 683038f285..35de7c2c15 100644 --- a/src/chocolatey/infrastructure.app/commands/ChocolateyApiKeyCommand.cs +++ b/src/chocolatey/infrastructure.app/commands/ChocolateyApiKeyCommand.cs @@ -1,13 +1,13 @@ // Copyright © 2017 - 2018 Chocolatey Software, Inc // Copyright © 2011 - 2017 RealDimensions Software, LLC -// +// // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. -// +// // You may obtain a copy of the License at -// +// // http://www.apache.org/licenses/LICENSE-2.0 -// +// // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -61,7 +61,7 @@ public virtual void handle_additional_argument_parsing(IList unparsedArg public virtual void handle_validation(ChocolateyConfiguration configuration) { - if (!configuration.ApiKeyCommand.Remove && !string.IsNullOrWhiteSpace(configuration.ApiKeyCommand.Key) + if (!configuration.ApiKeyCommand.Remove && !string.IsNullOrWhiteSpace(configuration.ApiKeyCommand.Key) && string.IsNullOrWhiteSpace(configuration.Sources)) { throw new ApplicationException("You must specify both 'source' and 'key' to set an API key."); @@ -69,7 +69,7 @@ public virtual void handle_validation(ChocolateyConfiguration configuration) if (configuration.ApiKeyCommand.Remove && string.IsNullOrWhiteSpace(configuration.Sources)) { throw new ApplicationException("You must specify 'source' to remove an API key."); - + } } @@ -77,7 +77,7 @@ public virtual void help_message(ChocolateyConfiguration configuration) { this.Log().Info(ChocolateyLoggers.Important, "ApiKey Command"); this.Log().Info(@" -This lists api keys that are set or sets an api key for a particular +This lists api keys that are set or sets an api key for a particular source so it doesn't need to be specified every time. Anything that doesn't contain source and key will list api keys. @@ -97,30 +97,30 @@ choco apikey choco apikey -s ""https://push.chocolatey.org/"" -k=""123-123123-123"" choco apikey -s ""http://internal_nexus"" -k=""user:password"" -For source location, this can be a folder/file share or an -http location. When it comes to urls, they can be different from the packages -url (where packages are searched and installed from). As an example, for -Chocolatey's community package package repository, the package url is -https://chocolatey.org/api/v2, but the push url is https://push.chocolatey.org -(and the deprecated https://chocolatey.org/ as a push url). Check the -documentation for your choice of repository to learn what the push url is. - -For the key, this can be an apikey that is provided by your source repository. -With some sources, like Nexus, this can be a NuGet API key or it could be a -user name and password specified as 'user:password' for the API key. Please see -your repository's documentation (for Nexus, please see +For source location, this can be a folder/file share or an +http location. When it comes to urls, they can be different from the packages +url (where packages are searched and installed from). As an example, for +Chocolatey's community package package repository, the package url is +https://community.chocolatey.org/api/v2/, but the push url is https://push.chocolatey.org +(and the deprecated https://chocolatey.org/ as a push url). Check the +documentation for your choice of repository to learn what the push url is. + +For the key, this can be an apikey that is provided by your source repository. +With some sources, like Nexus, this can be a NuGet API key or it could be a +user name and password specified as 'user:password' for the API key. Please see +your repository's documentation (for Nexus, please see https://bit.ly/nexus2apikey). -NOTE: See scripting in the command reference (`choco -?`) for how to +NOTE: See scripting in the command reference (`choco -?`) for how to write proper scripts and integrations. "); "chocolatey".Log().Info(ChocolateyLoggers.Important, "Connecting to Chocolatey.org (Community Package Repository)"); "chocolatey".Log().Info(() => @" -In order to save your API key for {0}, +In order to save your API key for {0}, log in (or register, confirm and then log in) to - {0}, go to {0}account, + {0}, go to {0}account, copy the API Key, and then use it in the following command: choco apikey -k -s {0} @@ -135,8 +135,8 @@ Exit codes that normally result from running this command. - 0: operation was successful, no issues detected - -1 or 1: an error has occurred -If you find other exit codes that we have not yet documented, please - file a ticket so we can document it at +If you find other exit codes that we have not yet documented, please + file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose. "); diff --git a/src/chocolatey/infrastructure.app/commands/ChocolateyInstallCommand.cs b/src/chocolatey/infrastructure.app/commands/ChocolateyInstallCommand.cs index ba9cf33556..aba2c220f2 100644 --- a/src/chocolatey/infrastructure.app/commands/ChocolateyInstallCommand.cs +++ b/src/chocolatey/infrastructure.app/commands/ChocolateyInstallCommand.cs @@ -279,7 +279,7 @@ choco install notepadplusplus googlechrome atom 7zip -dvfy choco install git -y --params=""'/GitAndUnixToolsOnPath /NoAutoCrlf'"" choco install git -y --params=""'/GitAndUnixToolsOnPath /NoAutoCrlf'"" --install-arguments=""'/DIR=C:\git'"" # Params are package parameters, passed to the package - # Install args are installer arguments, appended to the silentArgs + # Install args are installer arguments, appended to the silentArgs # in the package for the installer itself choco install nodejs.install --version 0.10.35 choco install git -s ""'https://somewhere/out/there'"" @@ -304,9 +304,9 @@ What is `-my`? See option bundling in the command reference option to not allow PATH changes. Until then you will need to manually go modify Path to just one Ruby and then use something like uru (https://bitbucket.org/jonforums/uru) or pik - (https://chocolatey.org/packages/pik) to switch between versions. + (https://community.chocolatey.org/packages/pik) to switch between versions. -NOTE: See scripting in the command reference (`choco -?`) for how to +NOTE: See scripting in the command reference (`choco -?`) for how to write proper scripts and integrations. "); @@ -410,10 +410,10 @@ on the local machine. "chocolatey".Log().Info(@" * How-To: A complete example of how you can use the PackageParameters argument when creating a Chocolatey Package can be seen at - https://chocolatey.org/docs/how-to-parse-package-parameters-argument + https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument * One may want to override the default installation directory of a piece of software. See - https://chocolatey.org/docs/getting-started#overriding-default-install-directory-or-other-advanced-install-concepts. + https://docs.chocolatey.org/en-us/getting-started#overriding-default-install-directory-or-other-advanced-install-concepts. "); diff --git a/src/chocolatey/infrastructure.app/commands/ChocolateySourceCommand.cs b/src/chocolatey/infrastructure.app/commands/ChocolateySourceCommand.cs index 25d5caf991..5bf439a804 100644 --- a/src/chocolatey/infrastructure.app/commands/ChocolateySourceCommand.cs +++ b/src/chocolatey/infrastructure.app/commands/ChocolateySourceCommand.cs @@ -1,13 +1,13 @@ // Copyright © 2017 - 2018 Chocolatey Software, Inc // Copyright © 2011 - 2017 RealDimensions Software, LLC -// +// // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. -// +// // You may obtain a copy of the License at -// +// // http://www.apache.org/licenses/LICENSE-2.0 -// +// // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -48,7 +48,7 @@ public virtual void configure_argument_parser(OptionSet optionSet, ChocolateyCon "Name - the name of the source. Required with actions other than list. Defaults to empty.", option => configuration.SourceCommand.Name = option.remove_surrounding_quotes()) .Add("s=|source=", - "Source - The source. This can be a folder/file share or an http location. If it is a url, it will be a location you can go to in a browser and it returns OData with something that says Packages in the browser, similar to what you see when you go to https://chocolatey.org/api/v2/. Required with add action. Defaults to empty.", + "Source - The source. This can be a folder/file share or an http location. If it is a url, it will be a location you can go to in a browser and it returns OData with something that says Packages in the browser, similar to what you see when you go to https://community.chocolatey.org/api/v2/. Required with add action. Defaults to empty.", option => configuration.Sources = option.remove_surrounding_quotes()) .Add("u=|user=", "User - used with authenticated feeds. Defaults to empty.", @@ -64,13 +64,13 @@ public virtual void configure_argument_parser(OptionSet optionSet, ChocolateyCon option => configuration.SourceCommand.CertificatePassword = option.remove_surrounding_quotes()) .Add("priority=", "Priority - The priority order of this source as compared to other sources, lower is better. Defaults to 0 (no priority). All priorities above 0 will be evaluated first, then zero-based values will be evaluated in config file order. Available in 0.9.9.9+.", - option => configuration.SourceCommand.Priority = int.Parse(option.remove_surrounding_quotes())) + option => configuration.SourceCommand.Priority = int.Parse(option.remove_surrounding_quotes())) .Add("bypassproxy|bypass-proxy", "Bypass Proxy - Should this source explicitly bypass any explicitly or system configured proxies? Defaults to false. Available in 0.10.4+.", option => configuration.SourceCommand.BypassProxy = option != null) .Add("allowselfservice|allow-self-service", "Allow Self-Service - Should this source be allowed to be used with self-service? Requires business edition (v1.10.0+) with feature 'useBackgroundServiceWithSelfServiceSourcesOnly' turned on. Defaults to false. Available in 0.10.4+.", - option => configuration.SourceCommand.AllowSelfService = option != null) + option => configuration.SourceCommand.AllowSelfService = option != null) .Add("adminonly|admin-only", "Visible to Administrators Only - Should this source be visible to non-administrators? Requires business edition (v1.12.2+). Defaults to false. Available in 0.10.8+.", option => configuration.SourceCommand.VisibleToAdminsOnly = option != null) @@ -104,7 +104,7 @@ public virtual void handle_validation(ChocolateyConfiguration configuration) { throw new ApplicationException("When specifying the subcommand '{0}', you must also specify --name.".format_with(configuration.SourceCommand.Command.to_string())); } - + if (configuration.SourceCommand.Command == SourceCommandType.add && string.IsNullOrWhiteSpace(configuration.Sources)) { throw new ApplicationException("When specifying the subcommand 'add', you must also specify --source.".format_with(configuration.SourceCommand.Command.to_string())); @@ -149,11 +149,11 @@ choco source list choco source remove -n=bob When it comes to the source location, this can be a folder/file share or an http -location. If it is a url, it will be a location you can go to in a browser and -it returns OData with something that says Packages in the browser, similar to -what you see when you go to https://chocolatey.org/api/v2/. +location. If it is a url, it will be a location you can go to in a browser and +it returns OData with something that says Packages in the browser, similar to +what you see when you go to https://community.chocolatey.org/api/v2/. -NOTE: See scripting in the command reference (`choco -?`) for how to +NOTE: See scripting in the command reference (`choco -?`) for how to write proper scripts and integrations. "); @@ -166,8 +166,8 @@ Exit codes that normally result from running this command. - 0: operation was successful, no issues detected - -1 or 1: an error has occurred -If you find other exit codes that we have not yet documented, please - file a ticket so we can document it at +If you find other exit codes that we have not yet documented, please + file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose. "); diff --git a/src/chocolatey/infrastructure.app/configuration/chocolatey.config b/src/chocolatey/infrastructure.app/configuration/chocolatey.config index 2a4275993d..216f20b480 100644 --- a/src/chocolatey/infrastructure.app/configuration/chocolatey.config +++ b/src/chocolatey/infrastructure.app/configuration/chocolatey.config @@ -9,7 +9,7 @@ - + diff --git a/src/chocolatey/infrastructure.app/runners/GenericRunner.cs b/src/chocolatey/infrastructure.app/runners/GenericRunner.cs index 4d1b597515..5daaf667c6 100644 --- a/src/chocolatey/infrastructure.app/runners/GenericRunner.cs +++ b/src/chocolatey/infrastructure.app/runners/GenericRunner.cs @@ -306,7 +306,8 @@ require admin rights. Only advanced users should run choco w/out an attempting to use Chocolatey in a non-administrator setting, you must select a different location other than the default install location. See - https://chocolatey.org/install#non-administrative-install for details. + https://docs.chocolatey.org/en-us/choco/setup#non-administrative-install + for details. "); var selection = InteractivePrompt.prompt_for_confirmation(@" Do you want to continue?", new[] { "yes", "no" }, diff --git a/src/chocolatey/infrastructure.app/services/NugetService.cs b/src/chocolatey/infrastructure.app/services/NugetService.cs index 15431c6826..95a20a6129 100644 --- a/src/chocolatey/infrastructure.app/services/NugetService.cs +++ b/src/chocolatey/infrastructure.app/services/NugetService.cs @@ -348,7 +348,7 @@ package prior to acceptance. You should have received an email. If you package page to contact moderators. Please ensure your registered email address is correct and emails from -noreply at chocolatey dot org are not being sent to your spam/junk +noreply at chocolatey dot org are not being sent to your spam/junk folder."); } } @@ -457,7 +457,7 @@ public virtual ConcurrentDictionary install_run(Chocolate if (installedPackage != null && (version == null || version == installedPackage.Version) && config.Force) { - this.Log().Warn(ChocolateyLoggers.Important, () => @"{0} v{1} already installed. Forcing reinstall of version '{1}'. + this.Log().Warn(ChocolateyLoggers.Important, () => @"{0} v{1} already installed. Forcing reinstall of version '{1}'. Please use upgrade if you meant to upgrade to a new version.".format_with(installedPackage.Id, installedPackage.Version)); version = installedPackage.Version; } @@ -481,10 +481,10 @@ public virtual ConcurrentDictionary install_run(Chocolate If the package version is a prerelease and you didn't specify `--pre`, the package may not be found.{2}{3}".format_with(packageName, config.Sources, string.IsNullOrWhiteSpace(config.Version) ? String.Empty : @" -Version was specified as '{0}'. It is possible that version +Version was specified as '{0}'. It is possible that version does not exist for '{1}' at the source specified.".format_with(config.Version.to_string(), packageName), @" -Please see https://chocolatey.org/docs/troubleshooting for more +Please see https://docs.chocolatey.org/en-us/troubleshooting for more assistance."); this.Log().Error(ChocolateyLoggers.Important, logMessage); var noPkgResult = packageInstalls.GetOrAdd(packageName, new PackageResult(packageName, version.to_string(), null)); @@ -1088,9 +1088,9 @@ public virtual void backup_existing_version(ChocolateyConfiguration config, IPac if (errored) { this.Log().Warn(ChocolateyLoggers.Important, - @"There was an error accessing files. This could mean there is a - process locking the folder or files. Please make sure nothing is - running that would lock the files or folders in this directory prior + @"There was an error accessing files. This could mean there is a + process locking the folder or files. Please make sure nothing is + running that would lock the files or folders in this directory prior to upgrade. If the package fails to upgrade, this is likely the cause."); } } @@ -1321,8 +1321,8 @@ public virtual ConcurrentDictionary uninstall_run(Chocola : "{0}.commandline".format_with(packageName); var timeoutInSeconds = config.PromptForConfirmation ? 0 : 20; - this.Log().Warn(@"You are uninstalling {0}, which is likely a metapackage for an - *.install/*.portable package that it installed + this.Log().Warn(@"You are uninstalling {0}, which is likely a metapackage for an + *.install/*.portable package that it installed ({0} represents discoverability).".format_with(packageName)); var selection = InteractivePrompt.prompt_for_confirmation( "Would you like to uninstall {0} as well?".format_with(actualPackageName), diff --git a/src/chocolatey/infrastructure.app/templates/ChocolateyInstallTemplate.cs b/src/chocolatey/infrastructure.app/templates/ChocolateyInstallTemplate.cs index 7dbcdc2c95..139a105523 100644 --- a/src/chocolatey/infrastructure.app/templates/ChocolateyInstallTemplate.cs +++ b/src/chocolatey/infrastructure.app/templates/ChocolateyInstallTemplate.cs @@ -1,13 +1,13 @@ // Copyright © 2017 - 2018 Chocolatey Software, Inc // Copyright © 2011 - 2017 RealDimensions Software, LLC -// +// // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. -// +// // You may obtain a copy of the License at -// +// // http://www.apache.org/licenses/LICENSE-2.0 -// +// // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -50,8 +50,8 @@ public class ChocolateyInstallTemplate softwareName = '[[PackageName]]*' #part or all of the Display Name as you see it in Programs and Features. It should be enough to be unique # Checksums are now required as of 0.10.0. - # To determine checksums, you can get that from the original site if provided. - # You can also use checksum.exe (choco install checksum) and use it + # To determine checksums, you can get that from the original site if provided. + # You can also use checksum.exe (choco install checksum) and use it # e.g. checksum -t sha256 -f path\to\file checksum = '[[Checksum]]' checksumType = '[[ChecksumType]]' #default is md5, can also be sha1, sha256 or sha512 @@ -73,50 +73,50 @@ public class ChocolateyInstallTemplate #silentArgs = '-s' # Ghost # Note that some installers, in addition to the silentArgs above, may also need assistance of AHK to achieve silence. #silentArgs = '' # none; make silent with input macro script like AutoHotKey (AHK) - # https://chocolatey.org/packages/autohotkey.portable + # https://community.chocolatey.org/packages/autohotkey.portable #validExitCodes= @(0) #please insert other valid exit codes here } -Install-ChocolateyPackage @packageArgs # https://chocolatey.org/docs/helpers-install-chocolatey-package -#Install-ChocolateyZipPackage @packageArgs # https://chocolatey.org/docs/helpers-install-chocolatey-zip-package -## If you are making your own internal packages (organizations), you can embed the installer or +Install-ChocolateyPackage @packageArgs # https://docs.chocolatey.org/en-us/create/functions/install-chocolateypackage +#Install-ChocolateyZipPackage @packageArgs # https://docs.chocolatey.org/en-us/create/functions/install-chocolateyzippackage +## If you are making your own internal packages (organizations), you can embed the installer or ## put on internal file share and use the following instead (you'll need to add $file to the above) -#Install-ChocolateyInstallPackage @packageArgs # https://chocolatey.org/docs/helpers-install-chocolatey-install-package +#Install-ChocolateyInstallPackage @packageArgs # https://docs.chocolatey.org/en-us/create/functions/install-chocolateyinstallpackage ## Main helper functions - these have error handling tucked into them already -## see https://chocolatey.org/docs/helpers-reference +## see https://docs.chocolatey.org/en-us/create/functions ## Install an application, will assert administrative rights -## - https://chocolatey.org/docs/helpers-install-chocolatey-package -## - https://chocolatey.org/docs/helpers-install-chocolatey-install-package +## - https://docs.chocolatey.org/en-us/create/functions/install-chocolateypackage +## - https://docs.chocolatey.org/en-us/create/functions/install-chocolateyinstallpackage ## add additional optional arguments as necessary ##Install-ChocolateyPackage $packageName $fileType $silentArgs $url [$url64 -validExitCodes $validExitCodes -checksum $checksum -checksumType $checksumType -checksum64 $checksum64 -checksumType64 $checksumType64] -## Download and unpack a zip file - https://chocolatey.org/docs/helpers-install-chocolatey-zip-package +## Download and unpack a zip file - https://docs.chocolatey.org/en-us/create/functions/install-chocolateyzippackage ##Install-ChocolateyZipPackage $packageName $url $toolsDir [$url64 -checksum $checksum -checksumType $checksumType -checksum64 $checksum64 -checksumType64 $checksumType64] -## Install Visual Studio Package - https://chocolatey.org/docs/helpers-install-chocolatey-vsix-package +## Install Visual Studio Package - https://docs.chocolatey.org/en-us/create/functions/install-chocolateyvsixpackage #Install-ChocolateyVsixPackage $packageName $url [$vsVersion] [-checksum $checksum -checksumType $checksumType] #Install-ChocolateyVsixPackage @packageArgs -## see the full list at https://chocolatey.org/docs/helpers-reference +## see the full list at https://docs.chocolatey.org/en-us/create/functions ## downloader that the main helpers use to download items ## if removing $url64, please remove from here -## - https://chocolatey.org/docs/helpers-get-chocolatey-web-file +## - https://docs.chocolatey.org/en-us/create/functions/get-chocolateywebfile #Get-ChocolateyWebFile $packageName 'DOWNLOAD_TO_FILE_FULL_PATH' $url $url64 ## Installer, will assert administrative rights - used by Install-ChocolateyPackage ## use this for embedding installers in the package when not going to community feed or when you have distribution rights -## - https://chocolatey.org/docs/helpers-install-chocolatey-install-package +## - https://docs.chocolatey.org/en-us/create/functions/install-chocolateyinstallpackage #Install-ChocolateyInstallPackage $packageName $fileType $silentArgs '_FULLFILEPATH_' -validExitCodes $validExitCodes ## Unzips a file to the specified location - auto overwrites existing content -## - https://chocolatey.org/docs/helpers-get-chocolatey-unzip +## - https://docs.chocolatey.org/en-us/create/functions/get-chocolateyunzipp #Get-ChocolateyUnzip ""FULL_LOCATION_TO_ZIP.zip"" $toolsDir ## Runs processes asserting UAC, will assert administrative rights - used by Install-ChocolateyInstallPackage -## - https://chocolatey.org/docs/helpers-start-chocolatey-process-as-admin +## - https://docs.chocolatey.org/en-us/create/functions/start-chocolateyprocessasadmin #Start-ChocolateyProcessAsAdmin 'STATEMENTS_TO_RUN' 'Optional_Application_If_Not_PowerShell' -validExitCodes $validExitCodes ## To avoid quoting issues, you can also assemble your -Statements in another variable and pass it in @@ -124,33 +124,33 @@ public class ChocolateyInstallTemplate ##Will resolve to C:\Program Files\appname #$statementsToRun = ""/C `""$appPath\bin\installservice.bat`"""" #Start-ChocolateyProcessAsAdmin $statementsToRun cmd -validExitCodes $validExitCodes - -## add specific folders to the path - any executables found in the chocolatey package -## folder will already be on the path. This is used in addition to that or for cases + +## add specific folders to the path - any executables found in the chocolatey package +## folder will already be on the path. This is used in addition to that or for cases ## when a native installer doesn't add things to the path. -## - https://chocolatey.org/docs/helpers-install-chocolatey-path +## - https://docs.chocolatey.org/en-us/create/functions/install-chocolateypath #Install-ChocolateyPath 'LOCATION_TO_ADD_TO_PATH' 'User_OR_Machine' # Machine will assert administrative rights ## Add specific files as shortcuts to the desktop -## - https://chocolatey.org/docs/helpers-install-chocolatey-shortcut +## - https://docs.chocolatey.org/en-us/create/functions/install-chocolateyshortcut #$target = Join-Path $toolsDir ""$($packageName).exe"" # Install-ChocolateyShortcut -shortcutFilePath """" -targetPath """" [-workDirectory ""C:\"" -arguments ""C:\test.txt"" -iconLocation ""C:\test.ico"" -description ""This is the description""] ## Outputs the bitness of the OS (either ""32"" or ""64"") -## - https://chocolatey.org/docs/helpers-get-o-s-architecture-width +## - https://docs.chocolatey.org/en-us/create/functions/get-osarchitecturewidth #$osBitness = Get-ProcessorBits ## Set persistent Environment variables -## - https://chocolatey.org/docs/helpers-install-chocolatey-environment-variable +## - https://docs.chocolatey.org/en-us/create/functions/install-chocolateyenvironmentvariable #Install-ChocolateyEnvironmentVariable -variableName ""SOMEVAR"" -variableValue ""value"" [-variableType = 'Machine' #Defaults to 'User'] ## Set up a file association -## - https://chocolatey.org/docs/helpers-install-chocolatey-file-association -#Install-ChocolateyFileAssociation +## - https://docs.chocolatey.org/en-us/create/functions/install-chocolateyfileassociation +#Install-ChocolateyFileAssociation ## Adding a shim when not automatically found - Cocolatey automatically shims exe files found in package directory. -## - https://chocolatey.org/docs/helpers-install-bin-file -## - https://chocolatey.org/docs/create-packages#how-do-i-exclude-executables-from-getting-shims +## - https://docs.chocolatey.org/en-us/create/functions/install-binfile +## - https://docs.chocolatey.org/en-us/create/create-packages#how-do-i-exclude-executables-from-getting-shims #Install-BinFile ##PORTABLE EXAMPLE diff --git a/src/chocolatey/infrastructure.app/templates/ChocolateyReadMeTemplate.cs b/src/chocolatey/infrastructure.app/templates/ChocolateyReadMeTemplate.cs index fd3e36fffd..c401502584 100644 --- a/src/chocolatey/infrastructure.app/templates/ChocolateyReadMeTemplate.cs +++ b/src/chocolatey/infrastructure.app/templates/ChocolateyReadMeTemplate.cs @@ -20,15 +20,15 @@ public class ChocolateyReadMeTemplate { public static string Template = @"## Summary -How do I create packages? See https://chocolatey.org/docs/create-packages +How do I create packages? See https://docs.chocolatey.org/en-us/create/create-packages -If you are submitting packages to the community feed (https://chocolatey.org) +If you are submitting packages to the community feed (https://community.chocolatey.org) always try to ensure you have read, understood and adhere to the create packages wiki link above. ## Automatic Packaging Updates? Consider making this package an automatic package, for the best -maintainability over time. Read up at https://chocolatey.org/docs/automatic-packages +maintainability over time. Read up at https://docs.chocolatey.org/en-us/create/automatic-packages ## Shim Generation Any executables you include in the package or download (but don't call @@ -42,18 +42,18 @@ Shim generation runs whether the package is self-contained or uses automation If the application is a GUI, you should create an empty file next to the exe named 'name.exe.gui' e.g. 'bob.exe' would need a file named 'bob.exe.gui'. -See https://chocolatey.org/docs/create-packages#how-do-i-set-up-shims-for-applications-that-have-a-gui +See https://docs.chocolatey.org/en-us/create/create-packages#how-do-i-set-up-shims-for-applications-that-have-a-gui If you want to ignore the executable, create an empty file next to the exe named 'name.exe.ignore' e.g. 'bob.exe' would need a file named 'bob.exe.ignore'. -See https://chocolatey.org/docs/create-packages#how-do-i-exclude-executables-from-getting-shims +See https://docs.chocolatey.org/en-us/create/create-packages#how-do-i-exclude-executables-from-getting-shims ## Self-Contained? If you have a self-contained package, you can remove the automation scripts entirely and just include the executables, they will automatically get shimmed, which puts them on the path. Ensure you have the legal right to distribute -the application though. See https://chocolatey.org/docs/legal. +the application though. See https://docs.chocolatey.org/en-us/information/legal. You should read up on the Shim Generation section to familiarize yourself on what to do with GUI applications and/or ignoring shims. @@ -64,18 +64,18 @@ You should read up on the Shim Generation section to familiarize yourself functions that you can use, these are sometimes called the helpers. ### Built-In Functions -https://chocolatey.org/docs/helpers-reference +https://docs.chocolatey.org/en-us/create/functions A note about a couple: -* Get-BinRoot - this is a horribly named function that doesn't do what new folks think it does. It gets you the 'tools' root, which by default is set to 'c:\tools', not the chocolateyInstall bin folder - see https://chocolatey.org/docs/helpers-get-tools-location -* Install-BinFile - used for non-exe files - executables are automatically shimmed... - see https://chocolatey.org/docs/helpers-install-bin-file -* Uninstall-BinFile - used for non-exe files - executables are automatically shimmed - see https://chocolatey.org/docs/helpers-uninstall-bin-file +* Get-BinRoot - this is a horribly named function that doesn't do what new folks think it does. It gets you the 'tools' root, which by default is set to 'c:\tools', not the chocolateyInstall bin folder - see https://docs.chocolatey.org/en-us/create/functions/get-toolslocation +* Install-BinFile - used for non-exe files - executables are automatically shimmed... - see https://docs.chocolatey.org/en-us/create/functions/install-binfile +* Uninstall-BinFile - used for non-exe files - executables are automatically shimmed - see https://docs.chocolatey.org/en-us/create/functions/uninstall-binfile ### Getting package specific information -Use the package parameters pattern - see https://chocolatey.org/docs/how-to-parse-package-parameters-argument +Use the package parameters pattern - see https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument ### Need to mount an ISO? -https://chocolatey.org/docs/how-to-mount-an-iso-in-chocolatey-package +https://docs.chocolatey.org/en-us/guides/create/mount-an-iso-in-chocolatey-package ### Environment Variables Chocolatey makes a number of environment variables available (You can access any of these with $env:TheVariableNameBelow): diff --git a/src/chocolatey/infrastructure.app/templates/ChocolateyTodoTemplate.cs b/src/chocolatey/infrastructure.app/templates/ChocolateyTodoTemplate.cs index b3637b7aca..047e773c9e 100644 --- a/src/chocolatey/infrastructure.app/templates/ChocolateyTodoTemplate.cs +++ b/src/chocolatey/infrastructure.app/templates/ChocolateyTodoTemplate.cs @@ -1,13 +1,13 @@ // Copyright © 2017 - 2018 Chocolatey Software, Inc // Copyright © 2011 - 2017 RealDimensions Software, LLC -// +// // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. -// +// // You may obtain a copy of the License at -// +// // http://www.apache.org/licenses/LICENSE-2.0 -// +// // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -21,98 +21,98 @@ public class ChocolateyTodoTemplate public static string Template = @"TODO -1. Determine Package Use: +1. Determine Package Use: - Organization? Internal Use? - You are not subject to distribution - rights when you keep everything internal. Put the binaries directly - into the tools directory (as long as total nupkg size is under 1GB). - When bigger, look to use from a share or download binaries from an - internal location. Embedded binaries makes for the most reliable use - of Chocolatey. Use `$fileLocation` (`$file`/`$file64`) and + Organization? Internal Use? - You are not subject to distribution + rights when you keep everything internal. Put the binaries directly + into the tools directory (as long as total nupkg size is under 1GB). + When bigger, look to use from a share or download binaries from an + internal location. Embedded binaries makes for the most reliable use + of Chocolatey. Use `$fileLocation` (`$file`/`$file64`) and `Install-ChocolateyInstallPackage`/`Get-ChocolateyUnzip` in tools\chocolateyInstall.ps1. - You can also choose to download from internal urls, see the next - section, but ignore whether you have distribution rights or not, it - doesn't apply. Under no circumstances should download from the - internet, it is completely unreliable. See - https://chocolatey.org/docs/community-packages-disclaimer#organizations + You can also choose to download from internal urls, see the next + section, but ignore whether you have distribution rights or not, it + doesn't apply. Under no circumstances should download from the + internet, it is completely unreliable. See + https://docs.chocolatey.org/en-us/community-repository/community-packages-disclaimer to understand the limitations of a publicly available repository. - Community Repository? + Community Repository? Have Distribution Rights? If you are the software vendor OR the software EXPLICITLY allows - redistribution and the total nupkg size will be under 200MB, you - have the option to embed the binaries directly into the package to - provide the most reliable install experience. Put the binaries - directly into the tools folder, use `$fileLocation` (`$file`/ + redistribution and the total nupkg size will be under 200MB, you + have the option to embed the binaries directly into the package to + provide the most reliable install experience. Put the binaries + directly into the tools folder, use `$fileLocation` (`$file`/ `$file64`) and `Install-ChocolateyInstallPackage`/ `Get-ChocolateyUnzip` in tools\chocolateyInstall.ps1. Additionally, fill out the LICENSE and VERIFICATION file (see 3 below and those files for specifics). - NOTE: You can choose to download binaries at runtime, but be sure + NOTE: You can choose to download binaries at runtime, but be sure the download location will remain stable. See the next section. Do Not Have Distribution Rights? - Note: Packages built this way cannot be 100% reliable, but it's a - constraint of publicly available packages and there is little + constraint of publicly available packages and there is little that can be done to change that. See - https://chocolatey.org/docs/community-packages-disclaimer#organizations - to better understand the limitations of a publicly available + https://docs.chocolatey.org/en-us/community-repository/community-packages-disclaimer + to better understand the limitations of a publicly available repository. Download Location is Publicly Available? - You will need to download the runtime files from their official - location at runtime. Use `$url`/`$url64` and + You will need to download the runtime files from their official + location at runtime. Use `$url`/`$url64` and `Install-ChocolateyPackage`/`Install-ChocolateyZipPackage` in tools\chocolateyInstall.ps1. Download Location is Not Publicly Available? - Stop here, you can't push this to the community repository. You - can ask the vendor for permission to embed, then include a PDF of - that signed permission directly in the package. Otherwise you - will need to seek alternate locations to non-publicly host the + Stop here, you can't push this to the community repository. You + can ask the vendor for permission to embed, then include a PDF of + that signed permission directly in the package. Otherwise you + will need to seek alternate locations to non-publicly host the package. Download Location Is Same For All Versions? You still need to point to those urls, but you may wish to set up something like Automatic Updater (AU) so that when a new version - of the software becomes available, the new package version + of the software becomes available, the new package version automatically gets pushed up to the community repository. See - https://chocolatey.org/docs/automatic-packages#automatic-updater-au + https://docs.chocolatey.org/en-us/create/automatic-packages#automatic-updater-au 2. Determine Package Type: -- Installer Package - contains an installer (everything in template is +- Installer Package - contains an installer (everything in template is geared towards this type of package) -- Zip Package - downloads or embeds and unpacks archives, may unpack - and run an installer using `Install-ChocolateyInstallPackage` as a +- Zip Package - downloads or embeds and unpacks archives, may unpack + and run an installer using `Install-ChocolateyInstallPackage` as a secondary step. -- Portable Package - Contains runtime binaries (or unpacks them as a - zip package) - cannot require administrative permissions to install +- Portable Package - Contains runtime binaries (or unpacks them as a + zip package) - cannot require administrative permissions to install or use - Config Package - sets config like files, registry keys, etc -- Extension Package - Packages that add PowerShell functions to - Chocolatey - https://chocolatey.org/docs/how-to-create-extensions +- Extension Package - Packages that add PowerShell functions to + Chocolatey - https://docs.chocolatey.org/en-us/features/extensions - Template Package - Packages that add templates like this for `choco - new -t=name` - https://chocolatey.org/docs/how-to-create-custom-package-templates + new -t=name` - https://docs.chocolatey.org/en-us/guides/create/create-custom-package-templates - Other - there are other types of packages as well, these are the main package types seen in the wild -3. Fill out the package contents: +3. Fill out the package contents: -- tools\chocolateyBeforeModify.ps1 - remove if you have no processes +- tools\chocolateyBeforeModify.ps1 - remove if you have no processes or services to shut down before upgrade/uninstall -- tools\LICENSE.txt / tools\VERIFICATION.txt - Remove if you are not - embedding binaries. Keep and fill out if you are embedding binaries - in the package AND pushing to the community repository, even if you - are the author of software. The file becomes easier to fill out - (does not require changes each version) if you are the software +- tools\LICENSE.txt / tools\VERIFICATION.txt - Remove if you are not + embedding binaries. Keep and fill out if you are embedding binaries + in the package AND pushing to the community repository, even if you + are the author of software. The file becomes easier to fill out + (does not require changes each version) if you are the software vendor. If you are building packages for internal use (organization, etc), you don't need these files as you are not subject to distribution rights internally. -- tools\chocolateyUninstall.ps1 - remove if autouninstaller can - automatically uninstall and you have nothing additional to do during +- tools\chocolateyUninstall.ps1 - remove if autouninstaller can + automatically uninstall and you have nothing additional to do during uninstall -- Readme.txt - delete this file once you have read over and used +- Readme.txt - delete this file once you have read over and used anything you've needed from here - nuspec - fill this out, then clean out all the comments (you may wish to leave the headers for the package vs software metadata) @@ -120,20 +120,20 @@ anything you've needed from here 4. ChocolateyInstall.ps1: -- For embedded binaries - use `$fileLocation` (`$file`/`$file64`) and +- For embedded binaries - use `$fileLocation` (`$file`/`$file64`) and `Install-ChocolateyInstallPackage`/ `Get-ChocolateyUnzip`. -- Downloading binaries at runtime - use `$url`/`$url64` and +- Downloading binaries at runtime - use `$url`/`$url64` and `Install-ChocolateyPackage` / `Install-ChocolateyZipPackage`. -- Other needs (creating files, setting registry keys), use regular +- Other needs (creating files, setting registry keys), use regular PowerShell to do so or see if there is a function already defined: - https://chocolatey.org/docs/helpers-reference + https://docs.chocolatey.org/en-us/create/functions - There may also be functions available in extension packages, see - https://chocolatey.org/packages?q=id%3A.extension for examples and + https://community.chocolatey.org/packages?q=id%3A.extension for examples and availability. - Clean out the comments and sections you are not using. -5. Test the package to ensure install/uninstall work appropriately. - There is a test environment you can use for this - +5. Test the package to ensure install/uninstall work appropriately. + There is a test environment you can use for this - https://github.com/chocolatey/chocolatey-test-environment 6. Learn more about Chocolatey packaging - go through the workshop at diff --git a/src/chocolatey/infrastructure.app/templates/ChocolateyUninstallTemplate.cs b/src/chocolatey/infrastructure.app/templates/ChocolateyUninstallTemplate.cs index 715212260a..d0ead8f27f 100644 --- a/src/chocolatey/infrastructure.app/templates/ChocolateyUninstallTemplate.cs +++ b/src/chocolatey/infrastructure.app/templates/ChocolateyUninstallTemplate.cs @@ -1,13 +1,13 @@ // Copyright © 2017 - 2018 Chocolatey Software, Inc // Copyright © 2011 - 2017 RealDimensions Software, LLC -// +// // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. -// +// // You may obtain a copy of the License at -// +// // http://www.apache.org/licenses/LICENSE-2.0 -// +// // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -25,8 +25,8 @@ public class ChocolateyUninstallTemplate ## NOTE: In 80-90% of the cases (95% with licensed versions due to Package Synchronizer and other enhancements), ## AutoUninstaller should be able to detect and handle registry uninstalls without a chocolateyUninstall.ps1. -## See https://chocolatey.org/docs/commands-uninstall -## and https://chocolatey.org/docs/helpers-uninstall-chocolatey-package +## See https://docs.chocolatey.org/en-us/choco/commands/uninstall +## and https://docs.chocolatey.org/en-us/create/functions/uninstall-chocolateypackage ## If this is an MSI, ensure 'softwareName' is appropriate, then clean up comments and you are done. ## If this is an exe, change fileType, silentArgs, and validExitCodes @@ -51,30 +51,30 @@ public class ChocolateyUninstallTemplate #silentArgs = '-s -u' # Ghost # Note that some installers, in addition to the silentArgs above, may also need assistance of AHK to achieve silence. #silentArgs = '' # none; make silent with input macro script like AutoHotKey (AHK) - # https://chocolatey.org/packages/autohotkey.portable + # https://community.chocolatey.org/packages/autohotkey.portable #validExitCodes= @(0) #please insert other valid exit codes here } $uninstalled = $false # Get-UninstallRegistryKey is new to 0.9.10, if supporting 0.9.9.x and below, # take a dependency on ""chocolatey-core.extension"" in your nuspec file. -# This is only a fuzzy search if $softwareName includes '*'. Otherwise it is +# This is only a fuzzy search if $softwareName includes '*'. Otherwise it is # exact. In the case of versions in key names, we recommend removing the version # and using '*'. [array]$key = Get-UninstallRegistryKey -SoftwareName $packageArgs['softwareName'] if ($key.Count -eq 1) { - $key | % { + $key | % { $packageArgs['file'] = ""$($_.UninstallString)"" #NOTE: You may need to split this if it contains spaces, see below - + if ($packageArgs['fileType'] -eq 'MSI') { - # The Product Code GUID is all that should be passed for MSI, and very - # FIRST, because it comes directly after /x, which is already set in the + # The Product Code GUID is all that should be passed for MSI, and very + # FIRST, because it comes directly after /x, which is already set in the # Uninstall-ChocolateyPackage msiargs (facepalm). $packageArgs['silentArgs'] = ""$($_.PSChildName) $($packageArgs['silentArgs'])"" - - # Don't pass anything for file, it is ignored for msi (facepalm number 2) - # Alternatively if you need to pass a path to an msi, determine that and + + # Don't pass anything for file, it is ignored for msi (facepalm number 2) + # Alternatively if you need to pass a path to an msi, determine that and # use it instead of the above in silentArgs, still very first $packageArgs['file'] = '' } else { @@ -97,10 +97,10 @@ public class ChocolateyUninstallTemplate } ## OTHER POWERSHELL FUNCTIONS -## https://chocolatey.org/docs/helpers-reference -#Uninstall-ChocolateyZipPackage $packageName # Only necessary if you did not unpack to package directory - see https://chocolatey.org/docs/helpers-uninstall-chocolatey-zip-package -#Uninstall-ChocolateyEnvironmentVariable # 0.9.10+ - https://chocolatey.org/docs/helpers-uninstall-chocolatey-environment-variable -#Uninstall-BinFile # Only needed if you used Install-BinFile - see https://chocolatey.org/docs/helpers-uninstall-bin-file +## https://docs.chocolatey.org/en-us/create/functions +#Uninstall-ChocolateyZipPackage $packageName # Only necessary if you did not unpack to package directory - see https://docs.chocolatey.org/en-us/create/functions/uninstall-chocolateyzippackage +#Uninstall-ChocolateyEnvironmentVariable # 0.9.10+ - https://docs.chocolatey.org/en-us/create/functions/uninstall-chocolateyenvironmentvariable +#Uninstall-BinFile # Only needed if you used Install-BinFile - see https://docs.chocolatey.org/en-us/create/functions/uninstall-binfile ## Remove any shortcuts you added in the install script. "; diff --git a/src/chocolatey/infrastructure.app/templates/NuspecTemplate.cs b/src/chocolatey/infrastructure.app/templates/NuspecTemplate.cs index 4ab6dc8a94..bc6637fa65 100644 --- a/src/chocolatey/infrastructure.app/templates/NuspecTemplate.cs +++ b/src/chocolatey/infrastructure.app/templates/NuspecTemplate.cs @@ -1,13 +1,13 @@ // Copyright © 2017 - 2018 Chocolatey Software, Inc // Copyright © 2011 - 2017 RealDimensions Software, LLC -// +// // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. -// +// // You may obtain a copy of the License at -// +// // http://www.apache.org/licenses/LICENSE-2.0 -// +// // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -20,8 +20,8 @@ public class NuspecTemplate { public static string Template = @" - - + + @@ -29,8 +29,8 @@ public class NuspecTemplate This is a nuspec. It mostly adheres to https://docs.nuget.org/create/Nuspec-Reference. Chocolatey uses a special version of NuGet.Core that allows us to do more than was initially possible. As such there are certain things to be aware of: * the package xmlns schema url may cause issues with nuget.exe -* Any of the following elements can ONLY be used by choco tools - projectSourceUrl, docsUrl, mailingListUrl, bugTrackerUrl, packageSourceUrl, provides, conflicts, replaces -* nuget.exe can still install packages with those elements but they are ignored. Any authoring tools or commands will error on those elements +* Any of the following elements can ONLY be used by choco tools - projectSourceUrl, docsUrl, mailingListUrl, bugTrackerUrl, packageSourceUrl, provides, conflicts, replaces +* nuget.exe can still install packages with those elements but they are ignored. Any authoring tools or commands will error on those elements --> @@ -72,7 +72,7 @@ public class NuspecTemplate __REPLACE__ __REPLACE__MarkDown_Okay [[AutomaticPackageNotesNuspec]] - + -