Skip to content

[YAML] Update script-only package formats in documentation#48113

Merged
melpike merged 2 commits into
docs-v4.90.0from
melpike-yaml-py-41470-v490
Jun 25, 2026
Merged

[YAML] Update script-only package formats in documentation#48113
melpike merged 2 commits into
docs-v4.90.0from
melpike-yaml-py-41470-v490

Conversation

@kilo-code-bot

@kilo-code-bot kilo-code-bot Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Related issue: Resolves #41470

Retargeted from #47611 to docs-v4.90.0.


Built for Mel Pike by Kilo for Slack

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.

Tip: disable this comment in your organization's Code Review settings.

@melpike melpike merged commit 86b5bf5 into docs-v4.90.0 Jun 25, 2026
6 checks passed
@melpike melpike deleted the melpike-yaml-py-41470-v490 branch June 25, 2026 15:51
cdcme added a commit that referenced this pull request Jul 13, 2026
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #48395 (story #41470)

Reconciles the `.py` script-only package reference docs against shipped
behavior. The feature guide (#48116) and reference docs (#48113 YAML,
#48115 REST API) are already merged to `docs-v4.90.0`; this fixes
remaining `.py` inconsistencies found during the #48395 reconciliation.

Docs-only PR against `docs-v4.90.0`.

## Changes

- **`docs/REST API/rest-api.md`** — corrected the Add-package platform
scoping: `.sh` and `.py` run on macOS and Linux, `.ps1` runs on Windows
(was "Windows or Linux hosts," which omitted macOS and wrongly implied
`.py` on Windows). Verified against
`SoftwareInstallerPlatformFromExtension` and the Unix-like
install-eligibility check in `ee/server/service/software_installers.go`.
- **`docs/Configuration/yaml-files.md`** — fixed a backtick typo in the
Script-only heading (`` .`py` `` → `` `.py` ``) and added `.py` to the
`controls.scripts` glob note (prose + example), matching the
already-merged `scripts.md` statement that `.py` scripts are supported
on macOS and Linux.

## No changes needed

- No new audit-log activity type —
`docs/Contributing/reference/audit-logs.md` unchanged.
- No new usage-statistics toggle — `articles/fleet-usage-statistics.md`
unchanged.
- Feature guide (`deploy-software-packages.md`, `scripts.md`, secrets
doc) already merged via #48116.
- `python_packages` in `rest-api.md` is the osquery inventory source for
installed pip packages — unrelated to `.py` packages, left as-is.

## Note

The script-only advanced-options wording (in `yaml-files.md` and
`deploy-software-packages.md`) is corrected separately in the #42797
docs PR against `docs-v4.89.0`; it reaches 4.90 via the normal
forward-merge.

# Checklist for submitter

- [x] QA'd all new/changed functionality manually (verified `.py`
platform mapping and script-extension handling in
`server/fleet/software_installer.go`, `server/fleet/scripts.go`,
`pkg/spec/gitops.go`)

<!-- Docs-only PR: no changes file, no code/tests, no migrations, no
config settings, no fleetd changes. -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants