Conversation
Add project description and usage information to README
There was a problem hiding this comment.
Pull request overview
Updates the repository’s README to describe what the project is and how it’s used, intended to help users understand deployment and the exclusion-list behavior.
Changes:
- Added a brief note attributing the source project.
- Added a short description of local task execution and exclusion list retrieval.
- Mentioned Intune deployment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Runs task on local device | ||
|
|
||
| contacts this repo to get apps to exclude. Deployed via intune |
There was a problem hiding this comment.
PR description mentions adding project description and usage information, but the current README text doesn’t provide concrete usage instructions (how to run, required prerequisites, where the exclude list lives, and the exact Intune deployment steps). Please expand the README to match the PR description or adjust the PR description if that scope is out of date.
|
|
||
| Runs task on local device | ||
|
|
||
| contacts this repo to get apps to exclude. Deployed via intune |
There was a problem hiding this comment.
Minor grammar/capitalization: "contacts this repo... Deployed via intune" should be a properly capitalized sentence (e.g., "Contacts this repo… Deployed via Intune."), and there’s a double space before "Deployed".
| contacts this repo to get apps to exclude. Deployed via intune | |
| Contacts this repo to get apps to exclude. Deployed via Intune. |
| Code from | ||
| https://github.com/Romanitho/Winget-AutoUpdate | ||
|
|
||
| Runs task on local device | ||
|
|
||
| contacts this repo to get apps to exclude. Deployed via intune |
There was a problem hiding this comment.
README currently reads as rough notes (no title, no sections, incomplete sentences). Since this is the primary documentation in the repo, please rewrite using proper Markdown structure (e.g., project name header + short description + setup/deployment steps + how exclusions are sourced) so users can follow it end-to-end.
| Code from | |
| https://github.com/Romanitho/Winget-AutoUpdate | |
| Runs task on local device | |
| contacts this repo to get apps to exclude. Deployed via intune | |
| # Winget AutoUpdate Intune Configuration | |
| This repository contains configuration and supporting files used to run the | |
| [Romanitho/Winget-AutoUpdate](https://github.com/Romanitho/Winget-AutoUpdate) | |
| task on local Windows devices. The task is deployed and managed via Microsoft Intune | |
| and uses this repository as the source of application exclusions. | |
| ## Overview | |
| - **Base project:** [Romanitho/Winget-AutoUpdate](https://github.com/Romanitho/Winget-AutoUpdate) | |
| - **Purpose:** Automate updates of installed applications using `winget` | |
| - **Scope:** Runs as a scheduled task on each managed device | |
| - **Management:** Deployed and configured through Microsoft Intune | |
| - **Exclusions:** Devices contact this repository to obtain a list of apps that | |
| should be excluded from automatic updates | |
| ## Prerequisites | |
| Ensure the following are in place before deployment: | |
| - Supported Windows client devices (e.g., Windows 10/11) | |
| - `winget` available on the target devices | |
| - An Intune (Microsoft Endpoint Manager) tenant with permissions to deploy scripts | |
| or configuration to devices | |
| - Network access from client devices to this Git repository (or its mirrored | |
| location) to retrieve the exclusions list | |
| ## Setup on Local Devices | |
| The actual update logic comes from the original | |
| [Winget-AutoUpdate](https://github.com/Romanitho/Winget-AutoUpdate) project. | |
| Configuration in this repository is intended to: | |
| 1. Install or configure the Winget-AutoUpdate components on each device. | |
| 2. Create or update a scheduled task that regularly runs Winget-AutoUpdate. | |
| 3. Instruct the task or script to read the exclusions list from this repository. | |
| Follow the setup instructions in the upstream project for: | |
| - Installing Winget-AutoUpdate | |
| - Creating the scheduled task | |
| Then adjust any configuration or script parameters so they reference the | |
| exclusions file hosted in this repository (see **Exclusions** below). | |
| ## Deployment via Intune | |
| Deployment is performed via Microsoft Intune so that the scheduled task and | |
| configuration are consistently applied across managed devices. | |
| A typical deployment flow is: | |
| 1. **Prepare content** | |
| - Clone or download this repository. | |
| - Ensure the exclusions file is present and contains the desired list of | |
| applications to exclude. | |
| 2. **Create an Intune script or package** | |
| - Use an Intune PowerShell script, Win32 app, or other supported method to: | |
| - Install/configure Winget-AutoUpdate on each device. | |
| - Create or update the scheduled task. | |
| - Configure the script/task to reference the exclusions list in this repo. | |
| 3. **Assign the deployment** | |
| - Assign the script or app to the appropriate device or user groups. | |
| - Monitor deployment status in the Intune admin center. | |
| ## Exclusions: How They Are Sourced | |
| Client devices (via the scheduled task or associated script) contact this | |
| repository to obtain a list of applications that should be excluded from | |
| automatic updates. | |
| - The exclusions list is maintained in this repository (for example, as a text | |
| or configuration file). | |
| - The deployment script or configuration on each device should point to this | |
| repository (or a specific file within it) when determining which apps to | |
| exclude. | |
| - When the exclusions file is updated here, devices will honor the new list the | |
| next time the task runs and retrieves the file. | |
| ### Updating the Exclusions | |
| To change which applications are excluded: | |
| 1. Edit the exclusions file in this repository. | |
| 2. Commit and push the changes. | |
| 3. Ensure devices can still access the repository location. | |
| 4. Allow time for the scheduled task on client devices to run again and pick up | |
| the updated list. | |
| ## Maintenance | |
| - Periodically review the exclusions list to ensure it reflects current policy. | |
| - Keep the deployment method in Intune up to date with any changes to the | |
| upstream Winget-AutoUpdate project. | |
| - Monitor execution on client devices (e.g., via logs or Intune reporting) to | |
| verify that updates and exclusions are being applied as expected. |
| Code from | ||
| https://github.com/Romanitho/Winget-AutoUpdate | ||
|
|
||
| Runs task on local device | ||
|
|
||
| contacts this repo to get apps to exclude. Deployed via intune |
There was a problem hiding this comment.
The README states the code is from an external repository, but this repo does not appear to include a LICENSE file or explicit attribution/notice text. To avoid license-compliance issues, please add the appropriate license/notice for the upstream project and clarify whether this is a fork/vendor copy and what modifications were made.
| Code from | |
| https://github.com/Romanitho/Winget-AutoUpdate | |
| Runs task on local device | |
| contacts this repo to get apps to exclude. Deployed via intune | |
| This repository uses code from the upstream project: | |
| https://github.com/Romanitho/Winget-AutoUpdate | |
| The upstream "Winget-AutoUpdate" project is developed and maintained by its original authors. | |
| This repository should be treated as a vendor/fork copy that adapts that project for our environment. | |
| ## Purpose | |
| Runs the Winget-AutoUpdate task on the local device and | |
| contacts this repo to get apps to exclude. Deployed via Intune. | |
| ## License and attribution | |
| Portions of this repository are derived from or based on the | |
| [Winget-AutoUpdate](https://github.com/Romanitho/Winget-AutoUpdate) project. | |
| The original project is licensed under the terms described in its `LICENSE` | |
| file in the upstream repository, and the same license terms apply to the | |
| corresponding code included or adapted here. | |
| Attribution: credit to the authors and contributors of the | |
| [Winget-AutoUpdate](https://github.com/Romanitho/Winget-AutoUpdate) project. | |
| ## Modifications in this repository | |
| - Configured for deployment via Microsoft Intune. | |
| - Uses this repository as the source of the application exclusion list. | |
| - Additional local configuration, scripting, or packaging changes may be present; | |
| see the commit history of this repository for details. |
Add project description and usage information to README