-
Notifications
You must be signed in to change notification settings - Fork 899
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
(doc) Update build instructions #3467
base: develop
Are you sure you want to change the base?
Conversation
We got some feedback that is wasn't easy to build Chocolatey CLI, as there were errors during process. This commit attempts to address this gap, and provide a complete list of all requirements/assumptions.
While this is not strictly needed, as the MSI for Chocolatey CLI is not always built, the inclusion of the *.wixproj in the Visual Studio *.sln file means that some parts of the build (like the restore task), does attempt to do stuff with WiX. While this doesn't actually stop the build from happening, as error is shown, and can cause confusion. Always installing the WiX tool prevents these errors from showing.
@flcdrg can I ask that you have a look at this PR, and provide any additional changes/suggestions? Thanks! |
@@ -3,4 +3,7 @@ if (-not $env:ChocolateyInstall -or -not (Test-Path "$env:ChocolateyInstall")) { | |||
Invoke-Expression ((New-Object net.webclient).DownloadString("https://community.chocolatey.org/install.ps1")) | |||
} | |||
|
|||
choco install pester -version 2.0.2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The tests do need Pester 5.3.1 - should this be installed here? (And probably mention this in the README?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Execution of the Pester tests is best done via the Vagrantfile that is provided, since it is possible that changes could be made to your system as a result of running the tests. This is documented here: https://github.com/chocolatey/choco/blob/develop/TESTING.md#pester-tests
I notice that we don't have a link to this section from the README.md file, which we likely should have.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These changes look good to me.
I'll hold off on merging in case there's any desire to tackle this comment in this PR:
I notice that we don't have a link to this section from the README.md file, which we likely should have.
Description Of Changes
Add documentation on how to complete build of Chocolatey CLI.
Motivation and Context
We got some feedback that is wasn't clear on how to build Chocolatey CLI
Testing
New VM in Azure Portal was created, and steps executed as documented.
Operating Systems Testing
N/A
Change Types Made
Change Checklist
Related Issue
N/A