Skip to content

Add docs doctor#2530

Merged
rinatkhaziev merged 2 commits intotrunkfrom
add/docs-doctor
Sep 3, 2025
Merged

Add docs doctor#2530
rinatkhaziev merged 2 commits intotrunkfrom
add/docs-doctor

Conversation

@rinatkhaziev
Copy link
Copy Markdown
Contributor

Description

This pull request updates the GitHub Actions workflow to enhance changelog generation and introduce automated documentation validation. The most important changes are the addition of a new job that analyzes documentation for inconsistencies and a workflow name update to reflect this expanded functionality.

Workflow improvements:

  • Updated the workflow name in .github/workflows/ai-changelog.yml to "Generate Changelog and Validate Docs for PR" to better reflect its dual purpose.

Documentation validation automation:

  • Added a new docs-doctor job to .github/workflows/ai-changelog.yml that runs when a pull request comment is /docs-doctor, analyzes docs.wpvip.com for inconsistencies using the Automattic/vip-actions/docs-doctor action, and generates a report.

Changelog Description

Added

Removed

Fixed

Changed

Pull request checklist

New release checklist

Steps to Test

Outline the steps to test and verify the PR here.

Example:

  1. Check out PR.
  2. Run npm run build
  3. Run ./dist/bin/vip-cookies.js nom
  4. Verify cookies are delicious.

@rinatkhaziev
Copy link
Copy Markdown
Contributor Author

/changelog

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Aug 29, 2025

Dependency Review

The following issues were found:
  • ✅ 0 vulnerable package(s)
  • ✅ 0 package(s) with incompatible licenses
  • ✅ 0 package(s) with invalid SPDX license definitions
  • ⚠️ 1 package(s) with unknown licenses.
See the Details below.

License Issues

.github/workflows/ai-changelog.yml

PackageVersionLicenseIssue Type
Automattic/vip-actions/docs-doctortrunkNullUnknown License

OpenSSF Scorecard

PackageVersionScoreDetails
actions/Automattic/vip-actions/docs-doctor trunk UnknownUnknown

Scanned Files

  • .github/workflows/ai-changelog.yml

@rinatkhaziev
Copy link
Copy Markdown
Contributor Author

/docs-doctor

@github-actions
Copy link
Copy Markdown
Contributor

AI-Generated Changelog Entry

  • You can now request an automated check for documentation inconsistencies, making it easier to identify and improve issues in the docs.

@rinatkhaziev
Copy link
Copy Markdown
Contributor Author

/docs-doctor

@sjinks
Copy link
Copy Markdown
Member

sjinks commented Aug 30, 2025

@rinatkhaziev, you will have to merge the PR to test it. The on: issue_comment workflows run only from the primary branch.

Copy link
Copy Markdown
Member

@sjinks sjinks left a comment

Choose a reason for hiding this comment

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

Please update the action version to point to the valid branch.

Co-authored-by: Volodymyr Kolesnykov <volodymyr.kolesnykov@automattic.com>
@rinatkhaziev rinatkhaziev requested a review from sjinks September 3, 2025 16:35
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Sep 3, 2025

github.event.comment.body == '/docs-doctor'
steps:
- name: Generate Report
uses: Automattic/vip-actions/docs-doctor@trunk

Check warning

Code scanning / CodeQL

Unpinned tag for a non-immutable Action in workflow Medium

Unpinned 3rd party Action 'Generate Changelog and Validate Docs for PR' step
Uses Step
uses 'Automattic/vip-actions/docs-doctor' with ref 'trunk', not a pinned commit hash
@rinatkhaziev rinatkhaziev merged commit ed75ae0 into trunk Sep 3, 2025
19 checks passed
@rinatkhaziev rinatkhaziev deleted the add/docs-doctor branch September 3, 2025 16:36
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