Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 2.91 KB

readme.md

File metadata and controls

58 lines (40 loc) · 2.91 KB
Raw
Branch Status
master Build status
development Build status

Community Chocolatey DSC Resource

Join the chat at https://gitter.im/chocolatey/cChoco

This resource is aimed at getting and installing packages using Chocolatey.

The resource takes the name of the package and will then install that package.

See ExampleConfig.ps1 for example usage.

See list of packages here: https://chocolatey.org/packages

Contributing

Happy to accept new features and fixes. Outstanding issues which can be worked on tagged Up For Grabs under issues.

Submitting a PR

Here's the general process of fixing an issue in the DSC Resource Kit:

  1. Fork the repository.
  2. Clone your fork to your machine.
  3. It's preferred to create a non-master working branch where you store updates.
  4. Make changes.
  5. Write pester tests to ensure that the issue is fixed.
  6. Submit a pull request to the development branch.
  7. Make sure all tests are passing in AppVeyor for your pull request.
  8. Make sure your code does not contain merge conflicts.
  9. Address comments (if any).

Build and Publishing

AppVeyor is used to package up the resource and publish to the PowerShell Gallery (on successful build from a newly pushed tag only).

The AppVeyor scripts do the following:

  • Test the resources using 'xDSCResourceDesigner'
  • Verify best practises using 'PSScriptAnalyzer'
  • Update the version in the manifest file
  • Publish the module to the PowerShell gallery
  • Check in updated manifest file to GitHub

To build:

  1. Update ModuleVersion in cChoco.psd1 - use major.minor.patch.0;
  2. Update version in appveyor.yml - use major.minor.patch.{build};
  3. Merge development branch to master - git checkout master, git merge development;
  4. Tag master with new version - git tag v<major.minor.patch>;
  5. Push changes with tag git push v<major.minor.patch>

Known Issues / Troubleshooting

WS-Management - Exceeds the maximum envelope size allowed

The maximum envelope size for WinRM is not sufficient for installing large packages. To increase the envelope size use winrm set winrm/config @{MaxEnvelopeSizekb=”153600″} - this exampe will increase it to 150MB.