Skip to content

Commit bcd2dab

Browse files
authored
Merge pull request #50 from fadwen/docs/readme-cleanup
docs(readme): keep the overview free of release history
2 parents 64bde11 + a7cce0e commit bcd2dab

2 files changed

Lines changed: 31 additions & 31 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,8 @@ All notable changes to this module are recorded here. Format follows
44
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versioning follows
55
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7-
Versions before 0.25.0 were released from the
8-
[powershell_scripts](https://github.com/fadwen/powershell_scripts) repository, where the module
9-
lived under `Scripts/Intune/IntuneScriptLab`. Their entries are carried over from the manifest's
10-
release notes.
7+
Versions before 0.25.0 were released from a private repository where the module began; their
8+
entries are carried over from the manifest's release notes.
119

1210
## [Unreleased]
1311

@@ -21,6 +19,11 @@ release notes.
2119

2220
### Changed
2321

22+
- The README's section headings no longer carry the version that introduced each feature, the
23+
tenant pre-flight paragraph no longer says since when each check exists, and the roadmap points
24+
at this changelog instead of listing versions; a first-time reader wants the overview, and the
25+
history is here. The changelog's own preamble no longer links to the private repository the
26+
module came from.
2427
- The `help` job in `quality-gates.yml`, the one that runs on Linux, also analyzes a folder of two
2528
fixture scripts with `Test-IntuneScript` and fails unless the return-before-exit detection and the
2629
silent Win32 detection are reported with the script type taken from the folder names. The static

‎README.md‎

Lines changed: 24 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ gets an `IslAssumedContext` note saying what was assumed; `-ExcludeRule IslAssum
119119

120120
For a mixed fleet run the analysis once per host you deploy to, e.g. `x86` and `arm64`.
121121

122-
## Suppressions and settings (0.13)
122+
## Suppressions and settings
123123

124124
```powershell
125125
# One line, from a trailing or preceding directive; the whole file from the header
@@ -156,7 +156,7 @@ PSScriptAnalyzer rules and the gate pick the file up on their own.
156156
[Examples/IntuneScriptLab.settings.psd1](./Examples/IntuneScriptLab.settings.psd1) is a commented
157157
template.
158158

159-
## Fixing what can be fixed (0.15)
159+
## Fixing what can be fixed
160160

161161
```powershell
162162
Repair-IntuneScript -Path .\Remediations -WhatIf
@@ -185,7 +185,7 @@ was meant, a `return` with an exit other than 0 after it in the same block (`ret
185185
there is no edit: `1; exit 0; exit 1` would behave the same, hide the exit the author wrote and
186186
leave no finding behind, so that one stays for a person. Findings carry the edit as `Fix`.
187187

188-
## Runtime harness (0.2)
188+
## Runtime harness
189189

190190
Runs a script the way the Intune Management Extension does and interprets the result the way
191191
Intune does. `-Context User` (the default) runs it as whoever is running the harness: Intune runs
@@ -225,7 +225,7 @@ output through the OEM code page, a timeout that kills the process tree, any non
225225
exit triggering the remediation, the Without issues / Fixed / Recurred / Failed mapping, last
226226
line + 2,048-character tail for remediations, full output for platform scripts.
227227

228-
### SYSTEM context (0.3)
228+
### SYSTEM context
229229

230230
`-Context System` on any of the runtime functions runs the script as `NT AUTHORITY\SYSTEM` in
231231
session 0, where the agent runs it, through a one-shot scheduled task (`cmd.exe` redirects the
@@ -238,7 +238,7 @@ flow and timeout cleanup all matched the agent's behaviour.
238238
Invoke-IntuneRemediationTest -DetectionPath .\Detect.ps1 -RemediationPath .\Remediate.ps1 -Context System
239239
```
240240

241-
### Running as another account (0.18)
241+
### Running as another account
242242

243243
```powershell
244244
$cred = Import-Clixml C:\ProgramData\IntuneScriptLab\isl-user.cred.xml # or Get-Credential
@@ -273,7 +273,7 @@ account granted Modify, since another account cannot reach your temp folder.
273273
account with a generated password stored as a DPAPI credential, and the `UserContext` integration
274274
suite runs against it when `ISL_TEST_CREDENTIAL` points at that file.
275275

276-
### Win32 app flow (0.3)
276+
### Win32 app flow
277277

278278
```powershell
279279
Invoke-IntuneWin32AppTest -DetectionPath .\Detect-App.ps1 -ContentPath .\Package `
@@ -295,7 +295,7 @@ Deviations: `User` is the default context (SYSTEM needs elevation); stdin is an
295295
stream rather than a hidden console, so a `Read-Host` returns immediately instead of hanging
296296
(`Test-IntuneScript` flags those); default timeouts are 5–10 minutes, not Intune's 30/60.
297297

298-
### Win32 rules, uninstall and signature check (0.6)
298+
### Win32 rules, uninstall and signature check
299299

300300
```powershell
301301
# A portal-style rule against this machine, evaluated the way the agent evaluates it
@@ -339,7 +339,7 @@ and MSI rules"):
339339
total at the agent's script policy fetches (a service start or restart, otherwise every 8
340340
hours), then Failed for good.
341341

342-
### Win32 base requirements and assignment facts (0.7)
342+
### Win32 base requirements and assignment facts
343343

344344
```powershell
345345
Test-IntuneWin32Requirement -Architecture x64 -MinimumWindowsRelease Windows11_23H2 -MinimumMemoryMB 4096
@@ -377,7 +377,7 @@ emulates:
377377
beta API on a policy that has one, it changed nothing and the remediation ran every hour; the
378378
same policy recreated with a detection script alone ran the detection alone.
379379

380-
### Win32 dependencies and supersedence (0.8)
380+
### Win32 dependencies and supersedence
381381

382382
```powershell
383383
$runtime = @{
@@ -412,7 +412,7 @@ The relationships page of an app, run in the order the agent was observed to run
412412
- Each related app gets an `IntuneScriptLab.Win32RelatedResult` in `Dependencies` or `Superseded`
413413
with its own pre and post detection, rule results and install or uninstall run.
414414

415-
### Reading the agent's own logs (0.9)
415+
### Reading the agent's own logs
416416

417417
```powershell
418418
Get-IntuneAgentLog -Id bbf7e139-fe9d-4783-80df-627b8e084059 -After (Get-Date).AddHours(-1)
@@ -435,7 +435,7 @@ and script output (`-ListEvent` shows them all). Filter by `-Log`, `-Id` (policy
435435
`-EventName`, `-Level`, `-After`/`-Before`, `-Pattern` and `-Last`. The files are opened with
436436
shared access, so the live agent is no obstacle, and a copied log folder works with `-Path`.
437437

438-
### The Enrollment Status Page (0.19)
438+
### The Enrollment Status Page
439439

440440
```powershell
441441
Get-IntuneAgentLog -EventName ScriptEspPhase, EspPhase, EspAppsSelected, EspAppRegistered,
@@ -464,7 +464,7 @@ closes, and a user-context script that writes to a SYSTEM-created file under Pro
464464
access denied and is reported as failed despite exit 0. The help of `Invoke-IntunePlatformScriptTest`
465465
and `Invoke-IntuneRemediationTest` carries the same notes.
466466

467-
### Timelines and a diagnostic package (0.23)
467+
### Timelines and a diagnostic package
468468

469469
```powershell
470470
Get-IntuneAgentTimeline -Log HealthScripts, AppWorkload -After (Get-Date).AddHours(-2)
@@ -496,7 +496,7 @@ subgraph an app is processed in, a skipped subgraph, the report that names the i
496496
its classification and conflict reason, the dependency toast, the unassigned child's missing intent
497497
and the content download step.
498498

499-
### Under PSScriptAnalyzer (0.10)
499+
### Under PSScriptAnalyzer
500500

501501
```powershell
502502
Invoke-ScriptAnalyzer -Path .\Remediations -Recurse -CustomRulePath (Get-IntuneAnalyzerRulePath) -IncludeDefaultRules
@@ -524,7 +524,7 @@ PSScriptAnalyzer registers every custom rule as Warning and filters on that, so
524524
returns none of them and `-Severity Warning` returns all of them, whatever each record says
525525
(PSScriptAnalyzer 1.25.0). Filter the output instead: `... | Where-Object Severity -eq Error`.
526526

527-
### Pre-flight against the tenant (0.11)
527+
### Pre-flight against the tenant
528528

529529
```powershell
530530
Connect-MgGraph -Scopes DeviceManagementScripts.Read.All, DeviceManagementConfiguration.Read.All,
@@ -552,18 +552,18 @@ with the script type, run-as account, bitness and signature check taken from the
552552
than inferred, so the verdict matches what the agent will do. Four deployment-level checks come
553553
from the rounds: a file `doesNotExist` detection rule (the agent does not evaluate it, W32-FILE-NOTEXIST),
554554
a user install context app assigned to a device group (never installed, W32-USER-INSTALL), a
555-
remediation with no remediation script (detection runs alone, REM-DETECTONLY) and, since 0.17, an
556-
assignment filter whose clause no Windows device can match (a `"x64"` architecture or a
557-
`"Microsoft Entra joined"` trust type, FLT-V25 / FLT-E07; `IslFilterIssue`). Since 0.21 the
558-
assignments themselves are checked too (round 9): a policy with no assignment or only exclusions
555+
remediation with no remediation script (detection runs alone, REM-DETECTONLY) and an assignment
556+
filter whose clause no Windows device can match (a `"x64"` architecture or a
557+
`"Microsoft Entra joined"` trust type, FLT-V25 / FLT-E07; `IslFilterIssue`). The assignments
558+
themselves are checked too (round 9): a policy with no assignment or only exclusions
559559
is never resolved by any device (Warning), a run-once schedule whose time has passed runs once at
560560
the fetch on a device that has not run it (`IslScheduleIssue`, Information), and a user-context
561561
script assigned to devices is skipped on Entra registered devices (Information). Filter by `-Kind`,
562562
`-Name`, `-Id`, `-IncludeRule`/`-ExcludeRule` and `-MinimumSeverity`; `-SkipGroupLookup` leaves groups
563563
alone. Nothing in the tenant is changed, and the module does not depend on the Graph SDK: it uses
564564
the session you connected.
565565

566-
### Assignment filters (0.17)
566+
### Assignment filters
567567

568568
```powershell
569569
Test-IntuneAssignmentFilter -Rule '(device.deviceName -startsWith "LAB-") and (device.operatingSystemVersion -ge 10.0.26100)'
@@ -595,7 +595,7 @@ filters from Graph. A value the service accepts but no Windows device reports (`
595595
assignment that carries such a filter. Evidence: `Validation/Findings.md`, "Assignment filter
596596
rules", produced by `Validation/Invoke-FilterProbe.ps1`.
597597

598-
### Drift against git (0.20)
598+
### Drift against git
599599

600600
```powershell
601601
Compare-IntuneDeployedScript -Path C:\Repos\intune-scripts | Where-Object State -ne InSync
@@ -618,7 +618,7 @@ that sets the context, architecture or signature check is compared with the poli
618618
Policies without a local file, ambiguous matches and local files the tenant has no script for are
619619
states of their own, so `Where-Object State -ne InSync` is the whole gate.
620620

621-
### Health report (0.22)
621+
### Health report
622622

623623
```powershell
624624
Get-IntuneScriptHealth -Path C:\Repos\intune-scripts -MarkdownPath .\intune-health.md | Where-Object Health -ne Healthy
@@ -645,7 +645,7 @@ Healthy otherwise, with the reasons in Notes. `-SkipAnalysis` and `-SkipRunState
645645
the run; a state that has not changed is not re-reported), `-MarkdownPath` writes the same report
646646
as a Markdown table per kind, Broken first.
647647

648-
### In a GitHub Actions workflow (0.12)
648+
### In a GitHub Actions workflow
649649

650650
```yaml
651651
# The analyze step, in short; Examples/intune-script-gate.yml is the complete workflow
@@ -672,7 +672,7 @@ suppressions for what a directive silenced), and the template's upload step puts
672672
the Security tab and on the pull request when `UPLOAD_SARIF` is switched on. A second, switched-off
673673
job shows where the runtime harness fits once a Pester suite from the template exists.
674674

675-
## In your own Pester suite (0.4)
675+
## In your own Pester suite
676676

677677
The module exports Pester 6.2 assertions (approved-verb `Assert-*` functions under `Should-*`
678678
aliases, so `Import-Module` stays warning-free):
@@ -740,7 +740,4 @@ Install-PSResource Microsoft.PowerShell.PlatyPS # 1.0.3 or later, once
740740

741741
## Roadmap
742742
- 1.0 once the Gallery release has had a few rounds of real use. Everything on the original list
743-
shipped: the Graph pre-flight (0.11), the GitHub Actions gate (0.12), suppressions and settings
744-
(0.13), SARIF (0.14), Repair-IntuneScript (0.15), filters (0.17), another account (0.18), the
745-
Enrollment Status Page (0.19), drift (0.20), assignment sanity (0.21), the health report (0.22),
746-
timelines and the diagnostic zip (0.23). See [CHANGELOG.md](CHANGELOG.md).
743+
has shipped; [CHANGELOG.md](CHANGELOG.md) says what arrived when.

0 commit comments

Comments
 (0)