From 8324170341a4896cf5036523e1d4e45a6776e7aa Mon Sep 17 00:00:00 2001 From: Paul Broadwith Date: Tue, 13 Nov 2018 09:44:56 +0000 Subject: [PATCH 1/5] (maint) Formatting --- readme.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 4f26d20..804b804 100644 --- a/readme.md +++ b/readme.md @@ -38,11 +38,11 @@ Here's the general process of fixing an issue in the DSC Resource Kit: 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). +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 -- Checkin updated manifest file to github +- Publish the module to the PowerShell gallery +- Check in updated manifest file to GitHub From 2a2603548fc45f9c104eeb77886a1cbe825ac743 Mon Sep 17 00:00:00 2001 From: Paul Broadwith Date: Tue, 13 Nov 2018 09:55:31 +0000 Subject: [PATCH 2/5] (maint) Add build instructions --- readme.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/readme.md b/readme.md index 804b804..dfb5e23 100644 --- a/readme.md +++ b/readme.md @@ -46,3 +46,11 @@ The AppVeyor scripts do the following: - 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`; +5. Push changes with tag `git push v` \ No newline at end of file From bfe0b43a121d617e6b1023763b5a894bc7198150 Mon Sep 17 00:00:00 2001 From: Paul Broadwith Date: Mon, 17 Jun 2019 10:27:06 +0100 Subject: [PATCH 3/5] (GH-126) Document WinRM envelope size issue --- readme.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index dfb5e23..7f8d31a 100644 --- a/readme.md +++ b/readme.md @@ -53,4 +53,10 @@ To build: 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`; -5. Push changes with tag `git push v` \ No newline at end of file +5. Push changes with tag `git push v` + +## 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. \ No newline at end of file From b0689474c856a148cf3f5c0cc58304fa41b64919 Mon Sep 17 00:00:00 2001 From: Paul Broadwith Date: Mon, 17 Jun 2019 10:28:06 +0100 Subject: [PATCH 4/5] (maint) Fix headings --- readme.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/readme.md b/readme.md index 7f8d31a..83f1d50 100644 --- a/readme.md +++ b/readme.md @@ -3,8 +3,7 @@ | master | [![Build status](https://ci.appveyor.com/api/projects/status/qma3jnh23w5vjt46/branch/master?svg=true&passingText=master%20-%20OK&pendingText=master%20-%20PENDING&failingText=master%20-%20FAILED)](https://ci.appveyor.com/project/LawrenceGripper/cchoco/branch/master) | | development | [![Build status](https://ci.appveyor.com/api/projects/status/qma3jnh23w5vjt46/branch/development?svg=true&passingText=development%20-%20OK&pendingText=development%20-%20PENDING&failingText=development%20-%20FAILED)](https://ci.appveyor.com/project/LawrenceGripper/cchoco/branch/development) | -Community Chocolatey DSC Resource -============================= +# Community Chocolatey DSC Resource [![Join the chat at https://gitter.im/chocolatey/cChoco](https://badges.gitter.im/chocolatey/cChoco.svg)](https://gitter.im/chocolatey/cChoco?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) @@ -16,13 +15,11 @@ See [ExampleConfig.ps1](ExampleConfig.ps1) for example usage. See list of packages here: https://chocolatey.org/packages -Contributing -============================= +## Contributing Happy to accept new features and fixes. Outstanding issues which can be worked on tagged HelpedWanted under issues. -Submitting a PR -============================= +### Submitting a PR Here's the general process of fixing an issue in the DSC Resource Kit: 1. Fork the repository. @@ -35,8 +32,7 @@ Here's the general process of fixing an issue in the DSC Resource Kit: 9. Make sure your code does not contain merge conflicts. 10. Address comments (if any). -Build and Publishing -============================ +### 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). From 0d1759c36c90b2a01cbbf28e9a6b1f2531429014 Mon Sep 17 00:00:00 2001 From: Paul Broadwith Date: Mon, 17 Jun 2019 10:29:30 +0100 Subject: [PATCH 5/5] (maint) Fix description and issue label --- readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 83f1d50..b8c6883 100644 --- a/readme.md +++ b/readme.md @@ -7,7 +7,7 @@ [![Join the chat at https://gitter.im/chocolatey/cChoco](https://badges.gitter.im/chocolatey/cChoco.svg)](https://gitter.im/chocolatey/cChoco?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -This resource is aimed at getting and installing packages from the choco gallery. +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. @@ -17,7 +17,7 @@ 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 HelpedWanted under issues. +Happy to accept new features and fixes. Outstanding issues which can be worked on tagged `Up For Grabs` under issues. ### Submitting a PR