Skip to content

Keep the Agent 365 guide and checklist aligned and fresh - #567

Merged
Alejandro Lopez (soyalejolopez) merged 1 commit into
microsoft:masterfrom
soyalejolopez:soyalejolopez-guide-checklist-sync
Oct 29, 2026
Merged

Alejandro Lopez (soyalejolopez) merged 1 commit into
microsoft:masterfrom
soyalejolopez:soyalejolopez-guide-checklist-sync

Conversation

@soyalejolopez

Copy link
Copy Markdown
Member

Category

  • New resource (script, agent, guide, analytics, skill)
  • Update to an existing resource
  • Bug fix
  • Docs, site, or tooling

What's in this pull request?

Keeps the Agent 365 Enablement Checklist and Customer Implementation Guide aligned and fresh, without editing either file.

The checklist names the guide section or step behind most of its tasks (100 tasks, 78 distinct references such as 04 Microsoft Purview, 4.04a), but only as free text. Nothing noticed if the guide renumbered a step, and nothing noticed when Microsoft Learn changed under either file.

Alignment check (part of npm run check, so it runs on every PR)

  • Every guide reference in the checklist must resolve to a section or step that exists in the guide. Renumbering or removing a guide step, or mistyping a reference, fails the check and names the checklist tasks affected.
  • Lists guide steps no checklist task points at (25 today), for information only.
  • Fails if either file's format changes enough that the check would stop reading it, rather than passing without checking anything.

Weekly freshness report (agent365-freshness.yml, Mondays 13:00 UTC and on demand)

  • Checks every Microsoft Learn link both files cite (297 distinct pages), reporting broken links, links that moved (with the new address), and Learn pages whose updated_at is later than each file's last review.
  • Flags a review older than 30 days, and a guide that is newer than the checklist review.
  • Opens or updates one issue labeled agent-365-freshness, and closes it when everything is clear. It does not change content, push, or open pull requests, so the Actions pull request policy does not affect it. It only needs issues: write.

Each file's review date is read from one place: CONTENT_REVIEWED in the checklist, and updated in the guide README. The resource folders are not touched in this pull request.

First run against today's content

0 references broken. 0 broken Learn links. 26 moved links (Microsoft moved the Agent 365 admin pages from microsoft-365/admin/manage/ to microsoft-agent-365/admin/; the old links still redirect). 34 Learn pages changed since the checklist's 2026-10-22 review and 37 since the guide's 2026-10-15 update.

How it was tested

  • New offline tests (test-agent365-sync.js) cover both readers, reference resolution, link classification, the report, and the workflow's permissions. I also confirmed the check fails when a guide step or section is removed or a reference is mistyped.
  • Ran the report live against Microsoft Learn (about 12 seconds).
  • Dry-ran the workflow's issue step with stubbed gh and jq for all four cases: open, update, close, and nothing to do.

Related issues

Part of the revamp tracked in #482.

Checklist

  • No private, customer-specific, or unlicensed content, and no secrets
  • README front matter is valid: npm ci --prefix tools/catalog-build && npm run check --prefix tools/catalog-build (passes: metadata valid for 58 resources, links resolve, 78 guide references resolve, all tests pass)
  • version and updated were bumped (not applicable: no resource changed; bumping the guide's updated would falsely mark it reviewed)
  • Installation and usage steps were tested (ran the report locally and dry-ran the workflow)
  • Files over 5 MB were avoided

See CONTRIBUTING.md for details.

Adds a check that every guide reference in the Enablement Checklist resolves in the Customer Implementation Guide (part of npm run check), and a weekly workflow that reports broken or moved Microsoft Learn links, Learn pages changed since each file was last reviewed, and overdue reviews in a single tracking issue. Neither edits content.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@soyalejolopez
Alejandro Lopez (soyalejolopez) merged commit 0c2c37e into microsoft:master Oct 29, 2026
5 checks passed
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