From 9783fe3cdf451f93e4c2e545e2f3fe9ce8d4cebc Mon Sep 17 00:00:00 2001 From: Adam Baali <45665341+AdamBaali@users.noreply.github.com> Date: Thu, 9 Apr 2026 00:09:02 +0200 Subject: [PATCH] Update yaml-files.md (#43144) Add script-only package documentation to the packages section. Script-only packages (.sh and .ps1 files) are a supported package type but had no example or guidance in the YAML configuration docs. This adds a "Script-only" example after the existing URL and Hash examples, documenting: - Script-only packages must be configured inline in the team YAML file - self_service, categories, labels, and icon are specified inline - Script packages do not support install_script, uninstall_script, post_install_script, pre_install_query, or automatic install - Separate package YAML files are not currently supported for script-only packages --- docs/Configuration/yaml-files.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/Configuration/yaml-files.md b/docs/Configuration/yaml-files.md index b417ae0f25..043b51e3c0 100644 --- a/docs/Configuration/yaml-files.md +++ b/docs/Configuration/yaml-files.md @@ -657,6 +657,23 @@ You can view the hash for existing software in the software detail page in the F - hash_sha256: fd22528a87f3cfdb81aca981953aa5c8d7084581b9209bb69abf69c09a0afaaf ``` +##### Script-only + +Script-only packages (`.sh` and `.ps1` files) are referenced directly inline in the team YAML file. The file contents become the install script. Script packages do not support `install_script`, `uninstall_script`, `post_install_script`, `pre_install_query`, or automatic install (`install_software` in policies). + +`self_service`, `categories`, `labels`, and `icon` are specified inline in the team YAML file. + +```yaml +software: + packages: + - path: ../lib/linux/scripts/vpn-setup.sh + self_service: true + categories: + - Utilities +``` + +> Script-only packages do not currently support configuration via a separate package YAML file. All options must be specified inline in the team YAML file. + ### app_store_apps - `app_store_id` is the ID of the Apple App Store or Android Play Store app. You can find this ID at the end of the app's URL. For example, "Bear - Markdown Notes" URL is "https://apps.apple.com/us/app/bear-markdown-notes/id1016366447" making the `app_store_id` is "1016366447". Similarly, the URL for "Google Chrome" on Android is "https://play.google.com/store/apps/details?id=com.android.chrome," so the `app_store_id` is "com.android.chrome."