Merge pull request #1034 from Romanitho/release/2.8.0

Release 2.8.0

Author: Romanitho

.github/copilot-instructions.md

@@ -0,0 +1,51 @@
+# Copilot Instructions for Winget-AutoUpdate
+
+## Project Overview
+- **Winget-AutoUpdate (WAU)** automates daily updates of Windows applications using the `winget` tool, supporting both system and user contexts.
+- The project is PowerShell-centric, with core scripts in `Sources/Winget-AutoUpdate/` and modular functions in `functions/`.
+- GPO/Intune management is supported via ADMX/ADML templates in `Sources/Policies/ADMX/`.
+- Customization is enabled through "Mods" scripts in `Sources/Winget-AutoUpdate/mods/`.
+
+## Key Components
+- **Main scripts:**
+  - `Winget-Upgrade.ps1`: Main update logic, loads all functions from `functions/`.
+  - `Winget-Install.ps1`: Used for deployment scenarios (Intune/SCCM).
+  - `WAU-Notify.ps1`, `WAU-Policies.ps1`: Notification and policy handling.
+- **Functions:** Each PowerShell file in `functions/` implements a single responsibility (e.g., `Get-ExcludedApps.ps1`, `Update-App.ps1`).
+- **Mods:**
+  - Place custom scripts in `mods/` to hook into app install/upgrade events (see `mods/README.md`).
+  - Supported hooks: `-preinstall`, `-upgrade`, `-install`, `-installed`, `-notinstalled`.
+  - Global mods: `_WAU-mods.ps1`, `_WAU-mods-postsys.ps1`, `_WAU-notinstalled.ps1`.
+- **GPO/Intune:**
+  - ADMX/ADML files in `Sources/Policies/ADMX/` allow central management of WAU settings.
+  - Since v1.16.5, GPO Black/White lists are auto-detected—no need to set `-ListPath GPO`.
+
+## Developer Workflows
+- **No build step**: Scripts are run directly via PowerShell.
+- **Testing:**
+  - No formal test suite; test by running scripts with various parameters and checking logs in `logs/`.
+- **Debugging:**
+  - Logs are written to `logs/updates.log` (system context).
+  - Use `Write-ToLog` for custom debug output.
+- **Deployment:**
+  - MSI installer is built using Wix (see `Wix/`).
+  - Deploy via Intune/SCCM by installing the MSI package (WAU.msi).
+
+## Project Conventions
+- **All functions are dot-sourced at runtime from the `functions/` directory.**
+- **Mods**: Use the provided templates in `mods/` for custom logic. Scripts are matched by naming convention.
+- **GPO/Intune**: Only the `en-US` ADML file is supported.
+- **Lists**: `excluded_apps.txt` and `included_apps.txt` are used unless a GPO list is present (GPO always takes precedence).
+- **Wildcard support**: App lists support `*` wildcards (e.g., `Mozilla.Firefox*`).
+
+## Integration Points
+- **winget**: All app management is via the Windows Package Manager CLI.
+- **GPO/Intune**: Settings are read from registry or policy files if present.
+- **Wix**: Used for MSI packaging (see `Wix/build.wxs`).
+
+## Examples
+- To add a global mod: copy `_WAU-mods-template.ps1` to `_WAU-mods.ps1` and customize.
+- To exclude an app: add its ID to `excluded_apps.txt` or configure via GPO.
+- To deploy via Intune: use `Winget-Install.ps1` with appropriate parameters.
+
+For more, see `README.md`, `Sources/Policies/README.md`, and `Sources/Winget-AutoUpdate/mods/README.md`.

.github/workflows/GA_Mega-linter.yml

@@ -33,7 +33,7 @@ jobs:
     steps:
       # Git Checkout
       - name: Checkout Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           fetch-depth: 0

.github/workflows/GitFlow_Create-Release-Branch-and-PR.yaml

@@ -35,7 +35,7 @@ jobs:
 
       # Step 2: Checkout the develop branch which contains all approved features
       - name: Checkout code
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v5
         with:
           ref: develop  # Always create releases from develop branch
           fetch-depth: 0

.github/workflows/GitFlow_Make-Release-and-Sync-to-Dev.yml

@@ -29,7 +29,7 @@ jobs:
     steps:
       # Step 1: Checkout the code from the main branch after merge
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           token: ${{ secrets.GH_PAT_SYNC }}
           lfs: "true"
@@ -99,19 +99,26 @@ jobs:
 
           # Package ADMX policy templates
           echo "### Zip ADMX ###"
-          Compress-Archive -Path .\Sources\Policies\ADMX -DestinationPath .\WAU_ADMX.zip -Force
+          $admxPath = ".\Sources\Policies\ADMX\WAU.admx"
+          try {
+              (Get-Content $admxPath -Raw -ErrorAction Stop) -match 'revision="([\d\.]+)"' | Out-Null
+              $ADMXversion = $matches[1]
+              $admxZip = "WAU_ADMX_$($ADMXversion).zip"
+          }
+          catch {
+              Write-Host "Error getting WAU ADMX version!"
+              $admxZip = "WAU_ADMX.zip"
+          }
+          Compress-Archive -Path .\Sources\Policies\ADMX -DestinationPath .\$admxZip -Force
           Get-Item .\*.zip
+          echo "admx_zip_name=$admxZip" >> $env:GITHUB_OUTPUT
 
           # Calculate ADMX package hash for verification
           echo "### Get ADMX zip SHA ###"
-          $ADMXSHA = (Get-FileHash .\WAU_ADMX.zip).hash
-          echo " - WAU_ADMX.zip SHA256: $ADMXSHA"
+          $ADMXSHA = (Get-FileHash .\$admxZip).hash
+          echo " - $admxZip SHA256: $ADMXSHA"
           echo "admx_sha=$ADMXSHA" >> $env:GITHUB_OUTPUT
 
-          # Create installation counter file for tracking installs
-          echo "### Create install counter file ###"
-          echo "Install counter file." > WAU_InstallCounter
-
       # Step 4: Create stable GitHub release with all artifacts
       - name: Create release
         uses: ncipollo/release-action@bcfe5470707e8832e12347755757cec0eb3c22af # v1.18.0
@@ -120,23 +127,21 @@ jobs:
           prerelease: false  # This is a stable release
           generateReleaseNotes: true
           name: WAU ${{ steps.release_version.outputs.NextSemVer }}
-          artifacts: "WAU.msi,WAU_ADMX.zip,WAU_InstallCounter"
+          artifacts: "WAU.msi,${{ steps.build_project.outputs.admx_zip_name }}"
           body: |
             ## Files
             |Files|Hash (SHA256)|Downloads|
             |---|---|---|
             |[WAU.msi](https://github.com/Romanitho/Winget-AutoUpdate/releases/download/v${{ steps.release_version.outputs.NextSemVer }}/WAU.msi) (x64)|`${{ steps.build_project.outputs.msi_sha }}`|<picture>![WAU.msi](https://img.shields.io/github/downloads/Romanitho/Winget-AutoUpdate/v${{ steps.release_version.outputs.NextSemVer }}/WAU.msi?style=flat-square&label=&color=blue)</picture>|
-            |[WAU_ADMX.zip](https://github.com/Romanitho/Winget-AutoUpdate/releases/download/v${{ steps.release_version.outputs.NextSemVer }}/WAU_ADMX.zip)|`${{ steps.build_project.outputs.admx_sha }}`|<picture>![WAU_ADMX.zip](https://img.shields.io/github/downloads/Romanitho/Winget-AutoUpdate/v${{ steps.release_version.outputs.NextSemVer }}/WAU_ADMX.zip?style=flat-square&label=&color=blue)</picture>|
-
-            <picture>![Install counter](https://img.shields.io/github/downloads/Romanitho/Winget-AutoUpdate/v${{ steps.release_version.outputs.NextSemVer }}/WAU_InstallCounter?style=flat-square&label=Total%20reported%20installations%20for%20this%20release&color=blue)</picture>
+            |[${{ steps.build_project.outputs.admx_zip_name }}](https://github.com/Romanitho/Winget-AutoUpdate/releases/download/v${{ steps.release_version.outputs.NextSemVer }}/${{ steps.build_project.outputs.admx_zip_name }})|`${{ steps.build_project.outputs.admx_sha }}`|<picture>![${{ steps.build_project.outputs.admx_zip_name }}](https://img.shields.io/github/downloads/Romanitho/Winget-AutoUpdate/v${{ steps.release_version.outputs.NextSemVer }}/${{ steps.build_project.outputs.admx_zip_name }}?style=flat-square&label=&color=blue)</picture>|
 
   sync:
     name: Sync develop with main
     runs-on: ubuntu-latest
     needs: build
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           fetch-depth: 0
           token: ${{ secrets.GH_PAT_SYNC }}

.github/workflows/GitFlow_Nightly-builds.yml

@@ -28,7 +28,7 @@ jobs:
     steps:
       # Step 1: Checkout the develop branch for nightly builds
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           lfs: "true"
           fetch-depth: 0

README.md

@@ -27,7 +27,7 @@ The following command will install WAU through winget itself in the newest versi
 winget install Romanitho.Winget-AutoUpdate
 ```
 #### Alternative installation (for home admin users)
-You can also download the latest release of the add-on [WAU Settings GUI (for Winget-AutoUpdate)](https://github.com/KnifMelti/WAU-Settings-GUI) and install it (this will install both **WAU** and a **GUI** that provides a user-friendly portable standalone interface to modify every aspect of **Winget-AutoUpdate (WAU)** settings).
+You can also download the latest release of the add-on [WAU Settings GUI (for Winget-AutoUpdate)](https://github.com/KnifMelti/WAU-Settings-GUI) and install it (this will install both **WAU** and a **GUI** that provides a user-friendly portable standalone interface to modify every aspect of **Winget-AutoUpdate (WAU)**).
 
 ## Configurations
 ### Keep some apps out of Winget-AutoUpdate
@@ -39,15 +39,15 @@ You can update only pre-selected apps. To do so, create an "included_apps.txt" w
 
 > The lists can contain Wildcard (*). For instance ```Mozilla.Firefox*``` will take care of all Firefox channels.
 
-List and Mods folder content will be copied to WAU install location:  
+List and Mods folder content will be copied to WAU install location:
 ![explorer](https://github.com/user-attachments/assets/a37837b0-b61e-4ce7-b23c-fd8661585e40)
 
 
 ### Notification Level
 You can choose which notification will be displayed: `Full`, `Success only`, `Errors only` or `None`.
 
 ### Notification language
-You can easily translate toast notifications by creating your locale xml config file (and share it with us :) ).
+You can easily translate toast notifications by creating your locale xml config file (and share it with us 😉).
 
 ### When does the script run?
 WAU runs ,by default, at logon. You can configure the frequency with options (Daily, BiDaily, Weekly, BiWeekly, Monthly or Never).
@@ -110,7 +110,8 @@ It doesn't work to call Powershell in **CMD** to install **WAU** with the parame
 Instead you must escape **every** special character (notice the `%` escape too) like:<br>
 `-ListPath https://storagesample.blob.core.windows.net/sample-container^?v=2023-11-31^&sr=b^&sig=39Up9jzHkxhUIhFEjEh9594DIxe6cIRCgOVOICGSP%%3A377^&sp=rcw`
 
-If `-ListPath` is set to **GPO** the Black/White List can be managed from within the GPO itself under **Application GPO Blacklist**/**Application GPO Whitelist**. Thanks to [Weatherlights](https://github.com/Weatherlights) in [#256 (reply in thread)](https://github.com/Romanitho/Winget-AutoUpdate/discussions/256#discussioncomment-4710599)!
+
+If a blacklist or whitelist is configured via Group Policy (GPO), WAU will automatically use these settings. There is no longer a need to specify "GPO" as a value for `ListPath`, detection is automatic as soon as a list is defined in Group Policy.
 
 
 ### MODSPATH
@@ -162,7 +163,7 @@ Default value 6AM (06:00:00). Specify the time of the update interval execution
 
 ### UPDATESATTIMEDELAY
 Default value is none (00:00). This setting specifies the delay for the scheduled task.
-A scheduled task random delay adds a random amount of wait time (up to the specified maximum) before the task starts. 
+A scheduled task random delay adds a random amount of wait time (up to the specified maximum) before the task starts.
 This helps prevent many devices from running the task at the exact same time. This is not applicable to "on logon" triggers.
 
 ### DONOTRUNONMETERED
@@ -268,4 +269,3 @@ Feel free to give us any suggestions or optimizations in code and support us by
 [![GitHub release (release name instead of tag name)](https://img.shields.io/github/v/release/Romanitho/Winget-AutoUpdate?display_name=release&include_prereleases&label=Latest%20Release&style=flat-square)](https://github.com/Romanitho/Winget-AutoUpdate/releases/)
 
 </div>
-

Sources/Policies/ADMX/WAU.admx

@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="utf-8"?>
 <policyDefinitions xmlns:xsd="http://www.w3.org/2001/XMLSchema"
-  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" revision="5.1"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" revision="5.2"
   schemaVersion="1.0" xmlns="http://www.microsoft.com/GroupPolicy/PolicyDefinitions">
   <policyNamespaces>
     <target prefix="WAU" namespace="Romanitho.Policies.WAU" />
   </policyNamespaces>
-  <resources minRequiredRevision="5.1" fallbackCulture="en-us" />
+  <resources minRequiredRevision="5.2" fallbackCulture="en-us" />
   <supportedOn>
     <definitions>
       <definition name="SUPPORTED_WAU_1_16_0" displayName="$(string.SUPPORTED_WAU_1_16_0)" />

Sources/Policies/ADMX/en-US/WAU.adml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <policyDefinitionResources xmlns:xsd="http://www.w3.org/2001/XMLSchema"
-  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" revision="5.1" schemaVersion="1.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" revision="5.2" schemaVersion="1.0"
   xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions">
   <displayName>WinGet-AutoUpdate</displayName>
   <description>WinGet-AutoUpdate GPO Management</description>
@@ -47,9 +47,9 @@ If this policy is disabled or not configured, GPO Whitelist is not used.</string
       <string id="UseWhiteList_Explain">This policy setting specifies whether to use a Whitelist or not.
 
 If this policy is disabled or not configured, the default is No.</string>
-      <string id="ListPath_Name">Get Black/White List from external Path (URL/UNC/GPO/Local)</string>
-      <string id="ListPath_Explain">If this policy is enabled, you can set a (URL/UNC/GPO/Local) Path to external lists other than the default.
-If "Application GPO Blacklist/Whitelist" is set in this GPO the Path MUST be: GPO
+      <string id="ListPath_Name">Get Black/White List from external Path (URL/UNC/Local)</string>
+      <string id="ListPath_Explain">If this policy is enabled, you can set a (URL/UNC/Local) Path to external lists other than the default.
+If "Application GPO Blacklist/Whitelist" is set, this policy setting is ignored.
 
 If this policy is disabled or not configured, the default ListPath is used (WAU InstallLocation).</string>
       <string id="ModsPath_Name">Get Mods from external Path (URL/UNC/Local/AzureBlob)</string>
@@ -163,7 +163,7 @@ If this policy is disabled or not configured, the default no delay.</string>
       </presentation>
       <presentation id="ListPath">
         <textBox refId="ListPath">
-          <label>(URL/UNC/GPO/Local) Path:</label>
+          <label>(URL/UNC/Local) Path:</label>
         </textBox>
       </presentation>
       <presentation id="ModsPath">

Sources/Policies/README.md

@@ -7,25 +7,24 @@ In an enterprise environment, it's crucial that different groups can have differ
 ## Administrative Template
 
 ### To an Individual Computer
-1. Copy the **`WAU.admx`** file to your Policy Definitions template folder.  
-   Example: `C:\Windows\PolicyDefinitions`
-2. Copy the **`WAU.adml`** file to the matching language folder in your Policy Definitions folder.  
-   Example: `C:\Windows\PolicyDefinitions\en-US`
+1. Copy the **`WAU.admx`** file to your Policy Definitions template folder.
+   >Example: `C:\Windows\PolicyDefinitions`
+2. Copy the **`WAU.adml`** file to the matching language folder in your Policy Definitions folder.
+   >Example: `C:\Windows\PolicyDefinitions\en-US`
 
 ### To Active Directory
 1. On a domain controller or workstation with [RSAT](https://learn.microsoft.com/en-us/troubleshoot/windows-server/system-management-components/remote-server-administration-tools), go to the **PolicyDefinitions** folder (also known as the _Central Store_) on any domain controller for your domain.
-2. Copy the **`WAU.admx`** file to the PolicyDefinitions folder.  
-   Example: `%systemroot%\sysvol\domain\policies\PolicyDefinitions`
-3. Copy the **`WAU.adml`** file to the matching language folder in the PolicyDefinitions folder. Create the folder if it doesn't already exist.  
-   Example: `%systemroot%\sysvol\domain\policies\PolicyDefinitions\en-US`
+2. Copy the **`WAU.admx`** file to the PolicyDefinitions folder.
+   >Example: `%systemroot%\sysvol\domain\policies\PolicyDefinitions`
+3. Copy the **`WAU.adml`** file to the matching language folder in the PolicyDefinitions folder. Create the folder if it doesn't already exist.
+   >Example: `%systemroot%\sysvol\domain\policies\PolicyDefinitions\en-US`
 4. If your domain has more than one domain controller, the new [ADMX files](https://learn.microsoft.com/en-us/troubleshoot/windows-client/group-policy/create-and-manage-central-store) will be replicated to them at the next domain replication interval.
 
 ## Intune
 
-Please follow the comprehensive Microsoft documentation to import and manage the WAU policies:  
+Please follow the comprehensive Microsoft documentation to import and manage the WAU policies:
 [Import and Manage Administrative Templates in Intune](https://learn.microsoft.com/en-us/mem/intune-service/configuration/administrative-templates-import-custom#add-the-admx-and-adml-files)
 
 ## Important Notes
 
-- When using GPO or Intune policies, you need to enable `Activate WAU GPO Management` for the policies to work. This setting is not intuitive and should be part of any decommissioning considerations.
 - This project only supports the `en-US` ADML file.