Remove comments from winget .yaml

diskuv · Dec 5, 2023 · f34c6d5 · f34c6d5
1 parent 84b1520
commit f34c6d5
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 50 deletions.
diff --git a/i-network/winget/README.md b/i-network/winget/README.md
@@ -91,3 +91,78 @@ if (($env:USERNAME -eq "WDAGUtilityAccount") -or ($PWD.Path -eq "C:\Users\WDAGUt
 # Rerun the installer; if you are prompted for security now you'll be able to click through it
 winget install --manifest ..\SandboxTest\manifest
 ```
+
+## To Organize
+
+Comments should not be in the `.yaml` files.
+
+```yaml
+# file: Diskuv.OCaml.yaml
+# Created using wingetcreate 1.1.2.0
+```
+
+```yaml
+# file: Diskuv.OCaml.locale.en-US.yaml
+
+# Created using wingetcreate 1.1.2.0
+#   Publisher
+#     Keep in sync with installer\src\private_common.ml "organization" which is used by
+#     https://github.com/diskuv/dkml-install-api/blob/main/package/console/common/Windows_registry.ml
+Publisher: Diskuv, Inc.
+```
+
+```yaml
+# file: Diskuv.OCaml.installer.yaml
+# Created using wingetcreate 1.1.2.0
+# Follow:
+#   https://docs.microsoft.com/en-us/windows/package-manager/package/manifest?tabs=minschema%2Cversion-example#tips-and-best-practices
+#   https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.2.0#best-practices
+# Reference: https://github.com/microsoft/winget-pkgs/blob/master/doc/manifest/schema/1.2.0/installer.md
+
+Commands:
+  # PATH entry: <DiskuvOCamlHome>/bin
+  # BUT ... already a [winget install opam] so do not register those commands!
+  # - opam
+  # - opam-installer
+  # - opam-putenv
+
+  # PATH entry: <DiskuvOCamlHome>/usr/bin
+  # BUT 1 ... max 16 entries in Commands:[] so took only the most commonly used
+  # BUT 2 ... will be a [winget install dune] so do not register those commands!
+  # - dune
+
+  # BUT 3 ... ocamldoc is essentially deprecated by odoc
+  # - ocamldoc
+  # BUT 4 ... native code tools are created at shim stage by [dkml init] or the shims [dune] or [opam]
+  # - ocamlopt
+  # - ocamlopt.opt
+
+  # BUT 5 ... with-dkml is deprecated and will be rolled into dkml
+  # - with-dkml
+
+# Minimum OS comes from https://github.com/diskuv/dkml-runtime-distribution/blob/ff7e6bcbf3dbdb37e64b20a57e2dea0fa9d27ed5/src/windows/Machine/Machine.psm1#L14:
+# > $Windows10SdkVer = "18362"
+MinimumOSVersion: 10.0.18362.0
+
+# Dependencies:
+# ExternalDependencies:
+#   - Microsoft.VisualStudio.2019.BuildTools
+#   - Git.Git
+# PackageDependencies:
+#   # ---- Visual Studio Redistributable ----
+#   # > The Microsoft Visual C++ 2015-2022 Redistributable Package (x64) installs runtime components of Visual C++ Libraries required to run 64-bit applications developed with Visual C++ 2015, 2017, 2019 and 2022 on a computer that does not have Visual C++ 2015, 2017, 2019 and 2022 installed.
+#   # - PackageIdentifier: Microsoft.VC++2015-2022Redist-x64
+
+#   # ---- Visual Studio Build Tools ----
+#   # Minimum comes from https://github.com/diskuv/dkml-runtime-distribution/blob/ff7e6bcbf3dbdb37e64b20a57e2dea0fa9d27ed5/src/windows/Machine/Machine.psm1#L94-L105:
+#   # > $VcStudioVcToolsMajorVer = 16
+#   # > $VcStudioVcToolsMinorVer = 6
+#   - PackageIdentifier: Microsoft.VisualStudio.2019.BuildTools
+#     MinimumVersion: 16.6.0
+
+#   # ---- Git ----
+#   # Minimum comes from https://github.com/diskuv/dkml-component-ocamlcompiler/blob/66af047444345a012213980269faffdf8ea83fb0/assets/staging-files/win32/setup-userprofile.ps1#L602-605
+#   - PackageIdentifier: Git.Git
+#     MinimumVersion: 2.34.0
+
+```
diff --git a/i-network/winget/manifest/Diskuv.OCaml.installer.yaml b/i-network/winget/manifest/Diskuv.OCaml.installer.yaml
@@ -1,40 +1,16 @@
-# Created using wingetcreate 1.1.2.0
 # yaml-language-server: $schema=https://aka.ms/winget-manifest.installer.1.2.0.schema.json
-# Follow:
-#   https://docs.microsoft.com/en-us/windows/package-manager/package/manifest?tabs=minschema%2Cversion-example#tips-and-best-practices
-#   https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.2.0#best-practices
-# Reference: https://github.com/microsoft/winget-pkgs/blob/master/doc/manifest/schema/1.2.0/installer.md
 PackageIdentifier: Diskuv.OCaml
 PackageVersion: "2.1.0" # AUTO-BUMP
 # Scope: user
 UpgradeBehavior: uninstallPrevious
 Commands:
-  # PATH entry: <DiskuvOCamlHome>/bin
-  # BUT ... already a [winget install opam] so do not register those commands!
-  # - opam
-  # - opam-installer
-  # - opam-putenv
-
-  # PATH entry: <DiskuvOCamlHome>/usr/bin
-  # BUT 1 ... max 16 entries in Commands:[] so took only the most commonly used
-  # BUT 2 ... will be a [winget install dune] so do not register those commands!
-  # - dune
   - dkml
   - ocaml
   - ocamlc
   - ocamldebug
-  # BUT 3 ... ocamldoc is essentially deprecated by odoc
-  # - ocamldoc
-  # BUT 4 ... native code tools are created at shim stage by [dkml init] or the shims [dune] or [opam]
-  # - ocamlopt
-  # - ocamlopt.opt
   - ocamlrun
-  # BUT 5 ... with-dkml is deprecated and will be rolled into dkml
-  # - with-dkml
 Platform:
   - "Windows.Desktop"
-# Minimum OS comes from https://github.com/diskuv/dkml-runtime-distribution/blob/ff7e6bcbf3dbdb37e64b20a57e2dea0fa9d27ed5/src/windows/Machine/Machine.psm1#L14:
-# > $Windows10SdkVer = "18362"
 MinimumOSVersion: 10.0.18362.0
 InstallerType: exe
 InstallModes:
@@ -46,26 +22,6 @@ InstallerSwitches:
   Interactive: --color=always
   InstallLocation: --prefix "<INSTALLPATH>"
 ReleaseDate: 2023-12-02 # AUTO-BUMP
-# Dependencies:
-  # ExternalDependencies:
-  #   - Microsoft.VisualStudio.2019.BuildTools
-  #   - Git.Git
-  # PackageDependencies:
-  #   # ---- Visual Studio Redistributable ----
-  #   # > The Microsoft Visual C++ 2015-2022 Redistributable Package (x64) installs runtime components of Visual C++ Libraries required to run 64-bit applications developed with Visual C++ 2015, 2017, 2019 and 2022 on a computer that does not have Visual C++ 2015, 2017, 2019 and 2022 installed.
-  #   # - PackageIdentifier: Microsoft.VC++2015-2022Redist-x64
-
-  #   # ---- Visual Studio Build Tools ----
-  #   # Minimum comes from https://github.com/diskuv/dkml-runtime-distribution/blob/ff7e6bcbf3dbdb37e64b20a57e2dea0fa9d27ed5/src/windows/Machine/Machine.psm1#L94-L105:
-  #   # > $VcStudioVcToolsMajorVer = 16
-  #   # > $VcStudioVcToolsMinorVer = 6
-  #   - PackageIdentifier: Microsoft.VisualStudio.2019.BuildTools
-  #     MinimumVersion: 16.6.0
-
-  #   # ---- Git ----
-  #   # Minimum comes from https://github.com/diskuv/dkml-component-ocamlcompiler/blob/66af047444345a012213980269faffdf8ea83fb0/assets/staging-files/win32/setup-userprofile.ps1#L602-605
-  #   - PackageIdentifier: Git.Git
-  #     MinimumVersion: 2.34.0
 Installers:
   - Architecture: x64
 

diff --git a/i-network/winget/manifest/Diskuv.OCaml.locale.en-US.yaml b/i-network/winget/manifest/Diskuv.OCaml.locale.en-US.yaml
@@ -1,12 +1,7 @@
-# Created using wingetcreate 1.1.2.0
 # yaml-language-server: $schema=https://aka.ms/winget-manifest.defaultLocale.1.2.0.schema.json
-
 PackageIdentifier: Diskuv.OCaml
 PackageVersion: "2.1.0" # AUTO-BUMP
 PackageLocale: en-US
-#   Publisher
-#     Keep in sync with installer\src\private_common.ml "organization" which is used by
-#     https://github.com/diskuv/dkml-install-api/blob/main/package/console/common/Windows_registry.ml
 Publisher: Diskuv, Inc.
 PublisherUrl: https://www.diskuv.com/
 PrivacyUrl: https://diskuv.com/legal#privacy_policy

diff --git a/i-network/winget/manifest/Diskuv.OCaml.yaml b/i-network/winget/manifest/Diskuv.OCaml.yaml
@@ -1,4 +1,3 @@
-# Created using wingetcreate 1.1.2.0
 # yaml-language-server: $schema=https://aka.ms/winget-manifest.version.1.2.0.schema.json
 PackageIdentifier: Diskuv.OCaml
 PackageVersion: "2.1.0" # AUTO-BUMP