Skip to content

Commit 1a43e73

Browse files
author
Morgan Rhodes
authored
Update DESIGN.md
1 parent 4f7e3a0 commit 1a43e73

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/DESIGN.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ We deal with these special cases by allowing the user to provide their own WiX f
1919
It’s possible many of these edge cases can be remedied in future releases of vanagon, such as the special casing of directories and files. But the benefit of “consistency” may not be enough to drive change for other cases, specifically because for things like custom actions the changes to vanagon would be so drastic and edge cased for windows, vanagon would start to look inconsistent with itself.
2020

2121
### Vanagon classes, functions, and WiX
22-
We made no major changes to the overall class structure in vanagon, most of the work has been done in the class functions to incorporate WiX. Following along the Vanagon::Driver class function [run](https://github.com/puppetlabs/vanagon/blob/master/lib/vanagon/driver.rb#L89L116) :
23-
24-
1. [Install_build_dependancies](https://github.com/puppetlabs/vanagon/blob/master/lib/vanagon/driver.rb#L98) remains unchanged. The underlying changes required to get dependencies for windows lies in the actual project, not vanagon itself.
25-
2. [Fetch_sources](https://github.com/puppetlabs/vanagon/blob/master/lib/vanagon/driver.rb#L99) also remains unchanged, though take note that this is NOT where we fetch any of the WiX source files. However this is where we will grab any .bat files to be put on the user’s PATH on install.
26-
3. [Make_makefile](https://github.com/puppetlabs/vanagon/blob/master/lib/vanagon/driver.rb#L100) is where some of the WiX magic begins to happen. Specifically the WiX compiler invocation exists under the generate_package function of Vanagon::Platform::Windows
27-
4. [Make_bill_of_materials](https://github.com/puppetlabs/vanagon/blob/master/lib/vanagon/driver.rb#L101) remains unchanged
28-
6. [Generate_pacakging_artifacts](https://github.com/puppetlabs/vanagon/blob/master/lib/vanagon/driver.rb#L102) is where we are actually adding / generating WiX files for the compiler to use. If you follow the objects down eventually you’ll find the [generate_msi_packaging_artifacts](https://github.com/puppetlabs/vanagon/blob/master/lib/vanagon/platform/windows.rb#L34L48) function inside Vanagon::Platform::Windows, where you’ll notice we do a mix of taking default files in vanagon and files from the project source and putting them in the workdir.
29-
7. - 10. The [remainder](https://github.com/puppetlabs/vanagon/blob/master/lib/vanagon/driver.rb#L103L106) of the driver functionality remains unchanged
22+
We made no major changes to the overall class structure in vanagon, most of the work has been done in the class functions to incorporate WiX. Following along the Vanagon::Driver class function [run](https://github.com/puppetlabs/vanagon/blob/main/lib/vanagon/driver.rb#L89L116) :
23+
24+
1. [Install_build_dependancies](https://github.com/puppetlabs/vanagon/blob/main/lib/vanagon/driver.rb#L98) remains unchanged. The underlying changes required to get dependencies for windows lies in the actual project, not vanagon itself.
25+
2. [Fetch_sources](https://github.com/puppetlabs/vanagon/blob/main/lib/vanagon/driver.rb#L99) also remains unchanged, though take note that this is NOT where we fetch any of the WiX source files. However this is where we will grab any .bat files to be put on the user’s PATH on install.
26+
3. [Make_makefile](https://github.com/puppetlabs/vanagon/blob/main/lib/vanagon/driver.rb#L100) is where some of the WiX magic begins to happen. Specifically the WiX compiler invocation exists under the generate_package function of Vanagon::Platform::Windows
27+
4. [Make_bill_of_materials](https://github.com/puppetlabs/vanagon/blob/main/lib/vanagon/driver.rb#L101) remains unchanged
28+
6. [Generate_pacakging_artifacts](https://github.com/puppetlabs/vanagon/blob/main/lib/vanagon/driver.rb#L102) is where we are actually adding / generating WiX files for the compiler to use. If you follow the objects down eventually you’ll find the [generate_msi_packaging_artifacts](https://github.com/puppetlabs/vanagon/blob/main/lib/vanagon/platform/windows.rb#L34L48) function inside Vanagon::Platform::Windows, where you’ll notice we do a mix of taking default files in vanagon and files from the project source and putting them in the workdir.
29+
7. - 10. The [remainder](https://github.com/puppetlabs/vanagon/blob/main/lib/vanagon/driver.rb#L103L106) of the driver functionality remains unchanged
3030

3131
You’ll notice that in vanagon, most of the functionality changes we made to ruby files was in Vanagon::Platform::Windows. However the WiX default files under resources/windows/wix also contain a large part of the new functionality.
3232

0 commit comments

Comments
 (0)