Codemap Action

A GitHub Action that generates a structural overview of your codebase and commits it as CODEMAP.md.

Uses codemap to analyze your repo — languages, file structure, function signatures — all in a clean Markdown document.

Usage

Add to .github/workflows/codemap.yml:

name: Update CODEMAP.md
on:
  push:
    branches: [main]

permissions:
  contents: write

jobs:
  codemap:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - uses: Taru0208/codemap-action@v1

That's it. On every push to main, your CODEMAP.md is auto-updated.

Inputs

Input	Description	Default
path	Directory to analyze	.
output	Output file path	CODEMAP.md
max-depth	Maximum directory depth	unlimited
ignore	Additional ignore patterns (comma-separated)
commit	Auto-commit the generated file	true
commit-message	Commit message	docs: update CODEMAP.md

Examples

Analyze only src/

- uses: Taru0208/codemap-action@v1
  with:
    path: src
    output: docs/CODEMAP.md

Generate without committing

- uses: Taru0208/codemap-action@v1
  with:
    commit: false

Shallow analysis with custom ignore

- uses: Taru0208/codemap-action@v1
  with:
    max-depth: 2
    ignore: "*.test.js,*.spec.ts,docs"

Output

The action generates Markdown with:

• File tree with language detection
• Function/class signatures for 30+ languages
• Line counts and file sizes
• Language distribution breakdown

License

MIT