Keep your architectural documentation and health grade automatically up-to-date on every push.
This action analyzes your codebase and injects a real-time dependency graph and health score directly into your repository's README.
1. Prepare your README
Add these exact two HTML comments anywhere in your repository's README.md. CodeAutopsy will safely inject your architecture report strictly between these tags:
2. Add the Workflow
Create a new file in your repository at .github/workflows/codeautopsy.yml and paste the following code:
name: Update CodeAutopsy Architecture
on:
push:
branches: [ "main", "master" ]
jobs:
update-readme:
runs-on: ubuntu-latest
permissions:
contents: write # Required to push the updated README back to your repo
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: CodeAutopsy Sync
uses: Sidhant0707/codeautopsy-action@v1.0.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
api_endpoint: "[https://codeautopsy-lyart.vercel.app/api/action-sync](https://codeautopsy-lyart.vercel.app/api/action-sync)"