Skip to content
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.

Sign up for GitHub

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

Jump to bottom

(doc) Update build instructions #3467

Merged
merged 4 commits into from
Oct 25, 2024
Merged

(doc) Update build instructions #3467

merged 4 commits into from
Oct 25, 2024
+45 −5

Commits on Oct 25, 2024

  1. (doc) Update build instructions 

    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.
    @gep13
    gep13 committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    74d5bf4 View commit details
    Browse the repository at this point in the history

  2. (build) Add installation of WiX as a tool 

    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.
    @gep13
    gep13 committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    fa4322b View commit details
    Browse the repository at this point in the history

  3. (doc) Be consistent about headings 

    Always add a new line after a heading in markdown. This makes the
document easier to read and parse.
    @gep13
    gep13 committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    96a1628 View commit details
    Browse the repository at this point in the history

  4. (doc) Add testing section to link to other docs 

    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
    gep13 committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    ca768c8 View commit details
    Browse the repository at this point in the history