Skip to content

Commit

Permalink
Update nuspecs to have descriptions and less comments
Browse files Browse the repository at this point in the history
  • Loading branch information
corbob committed Aug 26, 2024
1 parent e7e7c0c commit 30d0513
Show file tree
Hide file tree
Showing 8 changed files with 43 additions and 75 deletions.
2 changes: 1 addition & 1 deletion tests/packages/dependencyfailure/dependencyfailure.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<authors>__REPLACE_AUTHORS_OF_SOFTWARE_COMMA_SEPARATED__</authors>
<projectUrl>https://_Software_Location_REMOVE_OR_FILL_OUT_</projectUrl>
<tags>dependencyfailure admin SPACE_SEPARATED</tags>
<summary>__REPLACE__</summary>
<summary>Package includes a dependency for a package that is known to fail installation.</summary>
<description>
Package includes a dependency for a package that is known to fail installation.

Expand Down
4 changes: 2 additions & 2 deletions tests/packages/failingdependency/failingdependency.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
<authors>__REPLACE_AUTHORS_OF_SOFTWARE_COMMA_SEPARATED__</authors>
<projectUrl>https://_Software_Location_REMOVE_OR_FILL_OUT_</projectUrl>
<tags>dependencyfailure admin SPACE_SEPARATED</tags>
<summary>__REPLACE__</summary>
<description>__REPLACE__MarkDown_Okay </description>
<summary>Package that fails to install. Used as part of dependency tree.</summary>
<description>Package that fails to install. Used as part of dependency tree.</description>
</metadata>
<files>
<file src="tools\**" target="tools" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,12 @@
<authors>__REPLACE_AUTHORS_OF_SOFTWARE__</authors>
<owners>__REPLACE_YOUR_NAME__</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>__REPLACE__</description>
<summary>__REPLACE__</summary>
<description>
Package that contains dependencies that have dependencies that may fail to install.

Used for testing dependency resolution and ensuring dependency failures do not allow package installation.
</description>
<summary>Package that contains dependencies that have dependencies that may fail to install.</summary>
<releaseNotes />
<copyright />
<tags>hasfailingnesteddependency admin</tags>
Expand Down
68 changes: 2 additions & 66 deletions tests/packages/test-chocolateypath/test-chocolateypath.nuspec
Original file line number Diff line number Diff line change
@@ -1,81 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Read this before creating packages: https://docs.chocolatey.org/en-us/create/create-packages -->
<!-- It is especially important to read the above link to understand additional requirements when publishing packages to the community feed aka dot org (https://community.chocolatey.org/packages). -->

<!-- Test your packages in a test environment: https://github.com/chocolatey/chocolatey-test-environment -->

<!--
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
-->

<!-- You can embed software files directly into packages, as long as you are not bound by distribution rights. -->
<!-- * If you are an organization making private packages, you probably have no issues here -->
<!-- * If you are releasing to the community feed, you need to consider distribution rights. -->
<!-- Do not remove this test for UTF-8: if “Ω” doesn’t appear as greek uppercase omega letter enclosed in quotation marks, you should use an editor that supports UTF-8, not this one. -->
<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
<metadata>
<!-- == PACKAGE SPECIFIC SECTION == -->
<!-- This section is about this package, although id and version have ties back to the software -->
<!-- id is lowercase and if you want a good separator for words, use '-', not '.'. Dots are only acceptable as suffixes for certain types of packages, e.g. .install, .portable, .extension, .template -->
<!-- If the software is cross-platform, attempt to use the same id as the debian/rpm package(s) if possible. -->
<id>test-chocolateypath</id>
<!-- version should MATCH as closely as possible with the underlying software -->
<!-- Is the version a prerelease of a version? https://docs.nuget.org/create/versioning#creating-prerelease-packages -->
<!-- Note that unstable versions like 0.0.1 can be considered a released version, but it's possible that one can release a 0.0.1-beta before you release a 0.0.1 version. If the version number is final, that is considered a released version and not a prerelease. -->
<version>0.1.0</version>
<!-- <packageSourceUrl>Where is this Chocolatey package located (think GitHub)? packageSourceUrl is highly recommended for the community feed</packageSourceUrl>-->
<!-- owners is a poor name for maintainers of the package. It sticks around by this name for compatibility reasons. It basically means you. -->
<!--<owners>__REPLACE_YOUR_NAME__</owners>-->
<!-- ============================== -->

<!-- == SOFTWARE SPECIFIC SECTION == -->
<!-- This section is about the software itself -->
<title>test-packagepath (Install)</title>
<authors>__REPLACE_AUTHORS_OF_SOFTWARE_COMMA_SEPARATED__</authors>
<!-- projectUrl is required for the community feed -->
<projectUrl>https://_Software_Location_REMOVE_OR_FILL_OUT_</projectUrl>
<!-- There are a number of CDN Services that can be used for hosting the Icon for a package. More information can be found here: https://docs.chocolatey.org/en-us/create/create-packages#package-icon-guidelines -->
<!-- Here is an example using Githack -->
<!--<iconUrl>http://rawcdn.githack.com/__REPLACE_YOUR_REPO__/master/icons/test-packagepath.png</iconUrl>-->
<!-- <copyright>Year Software Vendor</copyright> -->
<!-- If there is a license Url available, it is required for the community feed -->
<!-- <licenseUrl>Software License Location __REMOVE_OR_FILL_OUT__</licenseUrl>
<requireLicenseAcceptance>true</requireLicenseAcceptance>-->
<!--<projectSourceUrl>Software Source Location - is the software FOSS somewhere? Link to it with this</projectSourceUrl>-->
<!--<docsUrl>At what url are the software docs located?</docsUrl>-->
<!--<mailingListUrl></mailingListUrl>-->
<!--<bugTrackerUrl></bugTrackerUrl>-->
<tags>test-packagepath SPACE_SEPARATED</tags>
<summary>__REPLACE__</summary>
<description>__REPLACE__MarkDown_Okay </description>
<!-- <releaseNotes>__REPLACE_OR_REMOVE__MarkDown_Okay</releaseNotes> -->
<!-- =============================== -->

<!-- Specifying dependencies and version ranges? https://docs.nuget.org/create/versioning#specifying-version-ranges-in-.nuspec-files -->
<!--<dependencies>
<dependency id="" version="__MINIMUM_VERSION__" />
<dependency id="" version="[__EXACT_VERSION__]" />
<dependency id="" version="[_MIN_VERSION_INCLUSIVE, MAX_VERSION_INCLUSIVE]" />
<dependency id="" version="[_MIN_VERSION_INCLUSIVE, MAX_VERSION_EXCLUSIVE)" />
<dependency id="" />
<dependency id="chocolatey-core.extension" version="1.1.0" />
</dependencies>-->
<!-- chocolatey-core.extension - https://community.chocolatey.org/packages/chocolatey-core.extension
- You want to use Get-UninstallRegistryKey on less than 0.9.10 (in chocolateyUninstall.ps1)
- You want to use Get-PackageParameters and on less than 0.11.0
- You want to take advantage of other functions in the core community maintainer's team extension package
-->

<!--<provides>NOT YET IMPLEMENTED</provides>-->
<!--<conflicts>NOT YET IMPLEMENTED</conflicts>-->
<!--<replaces>NOT YET IMPLEMENTED</replaces>-->
<summary>Package to test the Get-ChocolateyPath Chocolatey PowerShell function.</summary>
<description>Package to test the Get-ChocolateyPath Chocolatey PowerShell function.</description>
</metadata>
<files>
<!-- this section controls what actually gets packaged into the Chocolatey package -->
<file src="tools\**" target="tools" />
</files>
</package>
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,14 @@
<authors>__REPLACE_AUTHORS_OF_SOFTWARE__</authors>
<owners>__REPLACE_YOUR_NAME__</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>__REPLACE__</description>
<description>
These packages can be used to test the installation or upgrading of packages that require an existing package to downgrade.

Each version is available as `upgradedowngradesdependency` and `downgradesdependency`. This is to allow testing of scenarios where `choco upgrade all` would process the dependency before and after the parent package.

- Version 1.0.0 contains a range that can be used in an upgrade scenario and has a dependency on `isdependency 1.0.0 or greater`
- Version 2.0.0 contains an exact dependency on `isdependency` with a version of `1.0.0`
</description>
<summary>Package to test for out of range dependencies. This 1st version have a valid exact range.</summary>
<releaseNotes />
<copyright />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,14 @@
<authors>__REPLACE_AUTHORS_OF_SOFTWARE__</authors>
<owners>__REPLACE_YOUR_NAME__</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>__REPLACE__</description>
<description>
These packages can be used to test the installation or upgrading of packages that require an existing package to downgrade.

Each version is available as `upgradedowngradesdependency` and `downgradesdependency`. This is to allow testing of scenarios where `choco upgrade all` would process the dependency before and after the parent package.

- Version 1.0.0 contains a range that can be used in an upgrade scenario and has a dependency on `isdependency 1.0.0 or greater`
- Version 2.0.0 contains an exact dependency on `isdependency` with a version of `1.0.0`
</description>
<summary>Package to test for out of range dependencies. This 1st version have a valid exact range.</summary>
<releaseNotes />
<copyright />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,14 @@
<authors>__REPLACE_AUTHORS_OF_SOFTWARE__</authors>
<owners>__REPLACE_YOUR_NAME__</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>__REPLACE__</description>
<description>
These packages can be used to test the installation or upgrading of packages that require an existing package to downgrade.

Each version is available as `upgradedowngradesdependency` and `downgradesdependency`. This is to allow testing of scenarios where `choco upgrade all` would process the dependency before and after the parent package.

- Version 1.0.0 contains a range that can be used in an upgrade scenario and has a dependency on `isdependency 1.0.0 or greater`
- Version 2.0.0 contains an exact dependency on `isdependency` with a version of `1.0.0`
</description>
<summary>Package to test for out of range dependencies. This version uses a dependency that require a lower version.</summary>
<releaseNotes />
<copyright />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,14 @@
<authors>__REPLACE_AUTHORS_OF_SOFTWARE__</authors>
<owners>__REPLACE_YOUR_NAME__</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>__REPLACE__</description>
<description>
These packages can be used to test the installation or upgrading of packages that require an existing package to downgrade.

Each version is available as `upgradedowngradesdependency` and `downgradesdependency`. This is to allow testing of scenarios where `choco upgrade all` would process the dependency before and after the parent package.

- Version 1.0.0 contains a range that can be used in an upgrade scenario and has a dependency on `isdependency 1.0.0 or greater`
- Version 2.0.0 contains an exact dependency on `isdependency` with a version of `1.0.0`
</description>
<summary>Package to test for out of range dependencies. This version uses a dependency that require a lower version.</summary>
<releaseNotes />
<copyright />
Expand Down

0 comments on commit 30d0513

Please sign in to comment.