Skip to content

fix: update stale documentation date in release-process.md#1363

Merged
rezatnoMsirhC merged 5 commits intomicrosoft:mainfrom
Jah-yee:fix/update-stale-docs-date
Apr 17, 2026
Merged

fix: update stale documentation date in release-process.md#1363
rezatnoMsirhC merged 5 commits intomicrosoft:mainfrom
Jah-yee:fix/update-stale-docs-date

Conversation

@Jah-yee
Copy link
Copy Markdown
Contributor

@Jah-yee Jah-yee commented Apr 14, 2026

Description

This PR updates the ms.date frontmatter in docs/contributing/release-process.md from 2026-01-08 to 2026-04-14 to resolve the stale documentation detection issue.

Note: additional changes were implemented in the document freshness as well, to address drift with the real implementation of the release process.

Related Issue(s)

Fixes #1348

Type of Change

Select all that apply:

Code & Documentation:

  • Bug fix (non-breaking change fixing an issue)
  • New feature (non-breaking change adding functionality)
  • Breaking change (fix or feature causing existing functionality to change)
  • Documentation update

Infrastructure & Configuration:

  • GitHub Actions workflow
  • Linting configuration (markdown, PowerShell, etc.)
  • Security configuration
  • DevContainer configuration
  • Dependency update

AI Artifacts:

  • Reviewed contribution with prompt-builder agent and addressed all feedback
  • Copilot instructions (.github/instructions/*.instructions.md)
  • Copilot prompt (.github/prompts/*.prompt.md)
  • Copilot agent (.github/agents/*.agent.md)
  • Copilot skill (.github/skills/*/SKILL.md)

Other:

  • Script/automation (.ps1, .sh, .py)
  • Other (please describe):

Testing

Verified the date change by checking the file content. The ms.date value has been successfully updated from 2026-01-08 to 2026-04-14.

Checklist

Required Checks

  • Documentation is updated (if applicable) - Already updated in this PR
  • Files follow existing naming conventions
  • Changes are backwards compatible (if applicable)
  • Tests added for new functionality (if applicable)

@Jah-yee Jah-yee requested a review from a team as a code owner April 14, 2026 10:24
Copy link
Copy Markdown
Contributor

@katriendg katriendg left a comment

Choose a reason for hiding this comment

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

Thanks so much for your contribution, and welcome as a first-time contributor to hve-core. We really appreciate the effort.

Could you please update the issue PR description as per .github/PULL_REQUEST_TEMPLATE.md?
Even though this is a very small change, we think it will be good to keep exercising our default approach to PR creation and issue association.

A quick way to do this is to use the /pull-request prompt from this repo in GH Copilot, which can generate the expected PR description format for you. Once you run that, please update this PR description and we’ll continue from there.

The PR description needs to be linked about the associated issue to close/fix, which I believe is issue #1363 you want to link.

@Jah-yee
Copy link
Copy Markdown
Contributor Author

Jah-yee commented Apr 16, 2026

Good day @katriendg,

Thank you so much for the detailed review and warm welcome! I have updated the PR description to follow the Pull Request Template format.

Key updates made:

The ms.date frontmatter has been updated from 2026-01-08 to 2026-04-14 in docs/contributing/release-process.md to resolve the stale documentation detection issue.

Please let me know if there are any other adjustments needed. Thank you again for the guidance!

Warmly,
RoomWithOutRoof

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Apr 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.65%. Comparing base (4adb608) to head (f1b5334).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1363      +/-   ##
==========================================
- Coverage   87.66%   87.65%   -0.02%     
==========================================
  Files          61       61              
  Lines        9328     9328              
==========================================
- Hits         8177     8176       -1     
- Misses       1151     1152       +1     
Flag Coverage Δ
pester 85.22% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@rezatnoMsirhC rezatnoMsirhC left a comment

Choose a reason for hiding this comment

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

Thank you for this contribution, and a warm welcome as a first-time contributor to hve-core! 🎉

After reviewing the stale document, I want to flag a few things — both about the PR description and, more importantly, about the technical accuracy of the document itself. Issue #1348 asks us to "Verify technical accuracy of content" in addition to updating the date, so I'm noting potential accuracy gaps below for @WilliamBerryiii and others to review and address.


PR description: wrong issue link

The Fixes #1363 in the description is self-referencing (same number as this PR). The issue tracking this stale documentation work is #1348. Please update to Fixes #1348 so the issue closes automatically when this PR merges.


PR description: "New feature" checkbox

The "New feature" checkbox should be unchecked — updating ms.date is a documentation fix, not a new feature. Only "Documentation update" applies here.


Technical accuracy: Release PR updates more files than documented

The "The Release PR" section lists only package.json, extension/templates/package.template.json, and CHANGELOG.md. The extra-files in release-please-config.json also version-bumps:

  • .github/plugin/marketplace.json ($.metadata.version and $.plugins[*].version)
  • plugins/*/.github/plugin/plugin.json (glob across all plugin directories)

Technical accuracy: Release creates a draft — not a published release

release-please-config.json sets "draft": true. Merging the Release PR creates a draft GitHub Release, not a published one. The "How Releases Work" flowchart and "Reviewing the Release PR" section both say "A GitHub Release is created automatically" with no mention of the draft state.

The full publish lifecycle (as implemented in release-stable.yml) is:

  1. Merge Release PR → draft release and git tag created
  2. CI attaches VSIX packages, plugin ZIPs, SBOMs, and Sigstore attestations to the draft
  3. The publish-release job calls gh release edit --draft=false to auto-publish
  4. The release: published event triggers the extension marketplace publish workflow

None of steps 1–4 are reflected in the current documentation.


Technical accuracy: Extension publishing is fully automated — not manual

The "Extension Publishing" section states "VS Code extension publishing is manual via GitHub Actions workflow dispatch." In practice, the primary publish path is fully automated: the publish-release job in release-stable.yml promotes the draft to published, which fires the release: published trigger in release-marketplace-stable.yml automatically. The workflow_dispatch path is a manual fallback, not the primary flow.


Technical accuracy: Even/odd minor version convention undocumented

release-stable.yml enforces that stable releases must have even minor version numbers — odd minors fail CI with an explicit error. This convention is completely absent from the "Version Calculation" table and contributor guidance. A contributor seeing an odd-minor version bump would have no way to understand why CI fails.

@Jah-yee Jah-yee force-pushed the fix/update-stale-docs-date branch from 90e17b8 to ba3133d Compare April 17, 2026 00:28
- correct draft release lifecycle, asset attachment, and auto-promotion flow
- document automated extension publishing with manual fallback
- add even/odd minor version convention and extra-files to Release PR list
- update Mermaid diagram, overview steps, and quick reference table

📚 - Generated by Copilot
@katriendg
Copy link
Copy Markdown
Contributor

@Jah-yee given the more structural changes in the document, we've gone ahead and updated your document and branch with a few more changes. Your PR description is also updated. Nothing left for you to update.

@rezatnoMsirhC @WilliamBerryiii could you give it a final pass, the agent rewrote based on our current repo GH actions, but I'd like to double check. If yes please approve and merge. Thank you.

@katriendg katriendg requested a review from rezatnoMsirhC April 17, 2026 08:10
@rezatnoMsirhC rezatnoMsirhC merged commit 29a2df1 into microsoft:main Apr 17, 2026
45 of 46 checks passed
@Jah-yee Jah-yee deleted the fix/update-stale-docs-date branch April 24, 2026 20:08
WilliamBerryiii pushed a commit that referenced this pull request Apr 24, 2026
## Pre-Release 3.3.101

### ✨ Features

- add removed maturity tier and retire owasp-docker (#1444)
- add evaluation dataset creator (#1279)
- align RAI planner with guide, remove scoring, improve UX (#1287)
- add PSGallery staleness check and BOM cleanup (#1379)
- ISA-95 network planner agent (#1177)
- auto-generate collection.md with maturity filtering (#1316)
- add folder-consistency check and standardize WARN outp… (#1350)
- add synth-data-generate prompt to data-science collection (#1419)
- add canonical deck workflow and customer-card rendering for design
thinking (#1413)
- add Figma MCP integration for DT artifact export (#1222)
- introduce `owasp-docker` (#1245)
- replace hve-core-specific references with portable discovery-based
language (#1335)
- introduce `owasp-cicd` (#1246)
- add secure-by-design knowledge skill (#1223)
- introduce `owasp-infrastructure` (#1244)
- introduce `owasp-mcp` (#1207)
- add OutputPath parameter to Invoke-LinkLanguageCheck.ps1 (#1229)
- add -OutputPath parameter to Validate-SkillStructure.ps1 (#1225)
- add maintainer-only skip-review label guard (#1293)
- add extension collections overview and integrate into getting started
flow (#950)
- add agentic workflows for automated issue triage, implementation, PR
review, dependency review, and doc-staleness detection (#1219)
- consolidate package-lock.json version sync into
Update-VersionFiles.ps1 (#1240)
- add standards code review agent and full review orchestrator (#1174)
- standardize pytest-mock as Python mocking framework (#1170)
- add Jira backlog workflows and Jira/GitLab skills (#978)
- add centralized version bump script and supply-chain attestation
(#1183)

### 🐛 Bug Fixes

- pin PowerShell-Yaml to 0.4.7 across all install sites (#1378)
- close fork-PR/workflow-file-PR secret-strip gap and normalize
upload-artifact version (#1421)
- replace stream-based lookahead with array indexing in
list-changed-files.sh (#1376)
- centralize ISO 8601 timestamp regex in CIHelpers (#1343)
- update stale documentation date in release-process.md (#1363)
- pin basic-ftp to 5.3.0 to resolve GHSA-rp42-5vxx-qpwr (#1374)
- add bot filter to dependency PR review workflow (#1362)
- resolve pip-audit findings in powerpoint, gitlab, and jira skill lock
files (#1360)
- standardize Timestamp JSON key casing across all lint result files
(#1314)
- add synchronize trigger to PR Review workflow (#1323)
- standardize timestamp in Validate-SkillStructure.ps1 to use
Get-StandardTimestamp (#1280)
- add parallel subagent dispatch and structured JSON contracts to
code-review-full (#1304)
- standardize timestamp in SecurityHelpers.psm1 to use
Get-StandardTimestamp (#1284)
- standardize timestamps in Test-DependencyPinning.ps1 and
SecurityClasses.psm1 (#1282)
- derive collection artifact counts from YAML at build time (#1275)
- standardize timestamp in FrontmatterValidation.psm1 to use
Get-StandardTimestamp (#1285)
- standardize timestamp in Markdown-Link-Check.ps1 to use
Get-StandardTimestamp (#1283)
- escape hyphens in Mermaid diagram on Collections page (#1262)
- add summary timestamp to PSScriptAnalyzer output (#1211)
- fix plugin compatibility and robustness for coding-standards code
review agents (#1289)
- standardize timestamp in Test-CopyrightHeaders.ps1 to use
Get-StandardTimestamp (#1278)
- standardize timestamp in Invoke-YamlLint.ps1 to use
Get-StandardTimestamp (#1270)
- standardize timestamp in Invoke-LinkLanguageCheck.ps1 to use
Get-StandardTimestamp (#1264)
- fix dependency-review path filters and sparse-checkout cone mode
(#1259)
- replace invalid bare tool names with official tool identifiers (#1198)
- fix broken links and remove orphaned reference in code review docs
(#1257)
- exclude Python env dirs from skill validation warnings (#1255)
- pin happy-dom and serialize-javascript to resolve Dependabot
vulnerabilities (#1253)
- remove Mermaid diagram and add missing collection cards (#1247)
- disable MCP servers by default to prevent token limit errors (#1144)
- sync package-lock.json after pre-release version bump (#1236)
- separate mermaid node declarations and add dynamic diagram generation
with tests (#1215)
- replace anchor links in meeting-analyst with bold text references
(#1201)
- remove recursive symlinks in jira and gitlab skill directories (#1233)
- validate-installation scripts now check .github/skills directory
(#1010) (#1206)
- resolve npm audit vulnerabilities via dependency overrides (#1200)
- add post-release triggers to scorecard workflow (#1186)
- add missing .md extensions to relative links in agent documentation
(#1180)

### 📚 Documentation

- broaden Security Review description beyond OWASP (#1385)
- document maintainer advisory mode and skip-review label guard (#1386)
- document ExcludePaths/OutputPath for Invoke-LinkLanguageCheck (#1383)
- CLI getting-started: clarify plugin install commands as alternatives
(-all vs base) (#1251)

### ♻️ Refactoring

- align agent and prompt folder names to collection identifier (#1210)

### 🔧 Maintenance

- pin PSScriptAnalyzer to 1.25.0 and sync stale workflow version
comments (#1389)
- bump lxml from 6.0.2 to 6.1.0 in
/.github/skills/experimental/powerpoint (#1424)
- bump @vscode/vsce from 3.7.1 to 3.9.1 in the npm-dependencies group
(#1390)
- bump the github-actions group across 1 directory with 7 updates
(#1391)
- bump follow-redirects from 1.15.11 to 1.16.0 in /docs/docusaurus
(#1356)
- upgrade Node.js from 20 to 24 and bump cspell to v10 (#1353)
- bump basic-ftp from 5.2.0 to 5.2.1 (#1324)
- update github/gh-aw-actions requirement to
536ea1bad8c6715d098a9dc1afea8d403733acfe in the github-actions group
across 1 directory (#1298)
- update security instruction attributions and compliance (#1294)
- bump the npm-dependencies group with 2 updates (#1297)
- pre-release 3.3.41 (#1252)
- streamline RAI Planner phase structure and documentation (#1273)
- bump happy-dom from 20.8.8 to 20.8.9 in /docs/docusaurus (#1237)
- pre-release 3.3.27 (#1191)
- bump pygments from 2.19.2 to 2.20.0 in /.github/skills/gitlab/gitlab
(#1234)
- bump path-to-regexp from 0.1.12 to 0.1.13 in /docs/docusaurus (#1226)
- bump the github-actions group with 4 updates (#1231)
- add missing folders and alphabetize location lists (#1193)
- bump brace-expansion (#1224)
- bump handlebars from 4.7.8 to 4.7.9 in /docs/docusaurus (#1217)
- bump brace-expansion from 5.0.3 to 5.0.5 in /docs/docusaurus (#1213)
- pre-release 3.3.10 (#1187)
- bump markdownlint-cli2 from 0.21.0 to 0.22.0 in the npm-dependencies
group (#1175)
- bump the github-actions group with 3 updates (#1176)
- pre-release 3.3.1 (#1165)

---
*Managed automatically by pre-release workflow.*

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

docs: Update stale documentation - docs/contributing/release-process.md

5 participants