Skip to content

(maintainertoolkit) Adds new maintainertoolkit package#2778

Open
steviecoaster wants to merge 2 commits intochocolatey-community:masterfrom
steviecoaster:gh2777
Open

(maintainertoolkit) Adds new maintainertoolkit package#2778
steviecoaster wants to merge 2 commits intochocolatey-community:masterfrom
steviecoaster:gh2777

Conversation

@steviecoaster
Copy link
Copy Markdown
Contributor

@steviecoaster steviecoaster commented Mar 10, 2026

Description

maintainertoolkit is a metapackage to provide a set of development tools to aid in the creation and ongoing maintenance of Chocolatey packages. Primarily for the Chocolatey Community Repository, this package can also provide value to organizations looking to author and maintain packages internally.

Motivation and Context

Fixes #2777

How Has this Been Tested?

Developed and tested in a Windows Sandbox VM

Screenshot (if appropriate, usually isn't needed):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Migrated package (a package has been migrated from another repository)

Checklist:

  • My pull request is not coming from the master branch.
  • My code follows the code style of this repository.
  • My change requires a change to documentation (this usually means the notes in the description of a package).
  • I have updated the documentation accordingly (this usually means the notes in the description of a package).
  • I have updated the package description and it is less than 4000 characters.
  • All files are up to date with the latest Contributing Guidelines
  • The added/modified package passed install/uninstall in the Chocolatey Test Environment. Note that we don't support the use of any other environment.
  • The changes only affect a single package (not including meta package).

Copy link
Copy Markdown
Member

@AdmiringWorm AdmiringWorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I few things to update, and from the look of the description, you haven't ensured that the description is below 4 000 characters (I haven't checked either), that the package is up to date with our Contribution Guidelines, nor that the package works as expected in the Chocolatey Test Environment.

Those three are required to have been done before merging in a PR.

Description = 'Framework for keeping packages automatically up to date. Most community packages use this.'
}
[PSCustomObject]@{
Name = 'JSONPath/Fiddler / Browser DevTools'
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there meant to be a space between the JSONPath and Fiddler and the slash?

Similar to what you have between Fiddler and Browser

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think simplifying to just 'Fiddler' makes sense here!

<id>maintainertoolkit</id>
<version>1.0.0</version>
<packageSourceUrl>https://github.com/chocolatey-community/chocolatey-packages/blob/master/manual/maintainertoolkit/</packageSourceUrl>
<owners>chocolatey-community</owners>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is preferable to have at least one more user specified in the nuspec file, other than the chocolatey-community user.

Suggested change
<owners>chocolatey-community</owners>
<owners>chocolatey-community,steviecoaster</owners>

<packageSourceUrl>https://github.com/chocolatey-community/chocolatey-packages/blob/master/manual/maintainertoolkit/</packageSourceUrl>
<owners>chocolatey-community</owners>
<title>Chocolatey Package Maintenance Toolkit</title>
<authors>Chocolatey</authors>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this maybe be:

Suggested change
<authors>Chocolatey</authors>
<authors>Chocolatey Software</authors>

Normally, i would suggest Chocolatey Software, Inc, but since it isn't handled correctly on CCR, I think teh above is a better value.

<licenseUrl>https://github.com/chocolatey-community/chocolatey-packages/blob/master/manual/maintainertoolkit/LICENSE.md</licenseUrl>
<mailingListUrl>https://ch0.co/community</mailingListUrl>
<bugTrackerUrl>https://github.com/chocolatey-community/chocolatey-packages/issues</bugTrackerUrl>
<tags>maintainertoolkit packaging developer</tags>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tags doesn't match the obligitary tags in this repository, can you please have a look at the contribution guidelines, and make the appropriate changes to this?

https://github.com/chocolatey-community/chocolatey-packages/blob/master/CONTRIBUTING.md#obligatory-tags-and-categories

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't mind including this file, but just want to note that it won't be used anywhere in our systems. A ReadMe is only imported to the nuspec file when running the package creation/updating through AU.

This commit addresses chocolatey-community#2777 and adds a new manual package called
maintainertoolkit, a metapackage to provide a set of development
tools to aid in the creation and ongoing maintenance of Chocolatey
packages. Primarily for the Chocolatey Community Repository, this package
can also provide value to organizations looking to author and maintain
packages internally.
- Fixes tags in nuspec
- Fixes Author in nuspec
- Fixes git dependency version number
- Adds second maintainer name
- Clarifies output in install script
@steviecoaster steviecoaster marked this pull request as ready for review March 12, 2026 15:37
@steviecoaster
Copy link
Copy Markdown
Contributor Author

@AdmiringWorm, this works in the chocolatey-test-environment, but only if the VSCode package installs first. The vscode-powershell package doesn't include a dependency path that ensures vscode is installed, so it can fail to install the package.

Re-running the install is successful, since at that point the VS Code package was installed; the VS Code-Powershell package is fine. Unsure how to handle this in this package, since we can't guarantee the dependency order. I could just remove the vscode-powershell package, but I don't really want to.

@corbob
Copy link
Copy Markdown
Contributor

corbob commented Mar 12, 2026

@AdmiringWorm, this works in the chocolatey-test-environment, but only if the VSCode package installs first. The vscode-powershell package doesn't include a dependency path that ensures vscode is installed, so it can fail to install the package.

Re-running the install is successful, since at that point the VS Code package was installed; the VS Code-Powershell package is fine. Unsure how to handle this in this package, since we can't guarantee the dependency order. I could just remove the vscode-powershell package, but I don't really want to.

You could just issue the code command to install the extension in a chocolateyinstall.ps1...

The vscode-powershell package doesn't take a dependency because it could be user or system install and stable or insiders.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

(maintainertoolkit) Create maintainertoolkit package

3 participants