README.md

CodeSee Action

A composite GitHub action that encapsulates the CodeSee workflow.

How to use this action

1. Define a new action in your repository by adding a file in the .github/workflows/ directory. For example:

   touch .github/workflows/codesee.yml

2. Copy the following template into your new workflow file:

   on:
     push:
       branches:
         - main
     pull_request_target:
       types: [opened, synchronize, reopened]
   
   name: CodeSee
   
   permissions: read-all
   
   jobs:
     codesee:
       runs-on: ubuntu-latest
       continue-on-error: true
       name: Analyse the repo with CodeSee
       steps:
         - uses: Codesee-io/codesee-action@v2
           with:
             codesee-token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}

3. Commit the new workflow to GitHub.

4. That's it! CodeSee will analyze your code to keep your visualizations up to date.