(doc) Update build instructions #3467
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@flcdrg can I ask that you have a look at this PR, and provide any additional changes/suggestions? Thanks! |
Open
6 tasks
flcdrg
reviewed
Jun 17, 2024
corbob
previously approved these changes
Jun 19, 2024
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.
Always add a new line after a heading in markdown. This makes the document easier to read and parse.
It was pointed out in community discussion that the main README file doesn't mention anything to do with running tests for the Chocolatey CLI codebase. This commit adds a new Testing section to the README.md file, that links off to the pertinent information in the TESTING.md file. Used the Markdown All in One VSCode extension to update the table of contents. Initially this was adding an entry in the TOC section for the first heading, which was not there before, so added an entry in workspace settings.json file to exclude this. Updating this table of contents actually picked up on some previously entries which hadn't been added.
gep13
force-pushed
the
update-build-instructions
branch
from
f37f01b
to
ca768c8
Compare
|
@corbob as per discussions, I have updated this PR, and added a new section to link off to the TESTING.md file. Can you have another review of this, and if you are happy, this can be merged in. Thanks |
|
Thanks for getting this fixed up @gep13 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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