Skip to content

Conversation

@akash-deriv
Copy link
Collaborator

DocSync AI - Automated Documentation Updates

Adds a GitHub Action that automatically keeps documentation in sync with code changes using Claude AI.

What it does:

  • Monitors merged PRs and analyzes code changes
  • Uses Claude 3.7 Sonnet to intelligently update README.md and CLAUDE.md files
  • Creates documentation PRs automatically with the updates.

Usage:
Trigger on PR merge events to keep docs current without manual updates.

@github-actions
Copy link

github-actions bot commented Feb 6, 2026

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
  • ⚠️ 2 package(s) with unknown licenses.
See the Details below.

License Issues

.github/workflows/docsync-ai.yml

PackageVersionLicenseIssue Type
deriv-com/shared-actions/.github/actions/docsync_aimasterNullUnknown License
deriv-com/shared-actions/.github/actions/docsync_ai_commentmasterNullUnknown License

OpenSSF Scorecard

PackageVersionScoreDetails
actions/actions/checkout 4.*.* 🟢 6.4
Details
CheckScoreReason
Code-Review🟢 10all changesets reviewed
Maintained🟢 57 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 5
Dangerous-Workflow🟢 10no dangerous workflow patterns detected
Binary-Artifacts🟢 10no binaries found in the repo
CII-Best-Practices⚠️ 0no effort to earn an OpenSSF best practices badge detected
Token-Permissions⚠️ 0detected GitHub workflow tokens with excessive permissions
Fuzzing⚠️ 0project is not fuzzed
License🟢 10license file detected
Packaging⚠️ -1packaging workflow not detected
Pinned-Dependencies🟢 3dependency not pinned by hash detected -- score normalized to 3
Signed-Releases⚠️ -1no releases found
Security-Policy🟢 9security policy file detected
Branch-Protection🟢 6branch protection is not maximal on development and all release branches
Vulnerabilities🟢 73 existing vulnerabilities detected
SAST🟢 8SAST tool detected but not run on all commits
actions/deriv-com/shared-actions/.github/actions/docsync_ai master UnknownUnknown
actions/deriv-com/shared-actions/.github/actions/docsync_ai_comment master UnknownUnknown

Scanned Manifest Files

.github/workflows/docsync-ai.yml
  • actions/checkout@4.*.*
  • deriv-com/shared-actions/.github/actions/docsync_ai@master
  • deriv-com/shared-actions/.github/actions/docsync_ai_comment@master

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.

1 participant