Skip to content

Commit

Permalink
docs: update TODO list and enhance README badges
Browse files Browse the repository at this point in the history
  • Loading branch information
shaneholloman committed Dec 8, 2024
1 parent 4d70f6a commit 86c969f
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 1 deletion.
33 changes: 33 additions & 0 deletions .github/workflows/todos.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: TODOs

on:
push:
paths:
- 'docs/todo.md'
workflow_dispatch:

jobs:
update-badges:
runs-on: ubuntu-latest
permissions:
contents: write

steps:
- uses: actions/checkout@v3

- name: Install PowerShell
run: |
sudo apt-get update
sudo apt-get install -y powershell
- name: Update TODO badges
shell: pwsh
run: ./scripts/update-todo-badges.ps1

- name: Commit changes
run: |
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git add README.md
git diff --quiet && git diff --staged --quiet || git commit -m "docs: update todo badges"
git push
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ _codemaps/
private/
scripts/

## History
.history/

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

[![Pylint](https://github.com/shaneholloman/codemapper/actions/workflows/pylint.yml/badge.svg)](https://github.com/shaneholloman/codemapper/actions/workflows/pylint.yml)
[![PyTest](https://github.com/shaneholloman/codemapper/actions/workflows/pytest.yml/badge.svg)](https://github.com/shaneholloman/codemapper/actions/workflows/pytest.yml)
[![TODO](https://img.shields.io/badge/✔%20RoadMap-45-blue)](docs/todo.md)
[![TODO](https://img.shields.io/badge/✔%20Todo-47-purple)](docs/todo.md)
[![TODO](https://img.shields.io/badge/✔%20Done-8-purple)](docs/todo.md)

![logo](codemapper-outlined.webp)

<!-- TOC -->
Expand Down
2 changes: 2 additions & 0 deletions docs/todo.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ tag is: [`core`](https://github.com/users/shaneholloman/projects/9/views/7)

tag is: [`outputs`](https://github.com/users/shaneholloman/projects/9/views/7)

- [ ] Default output dirs will be .docmaps and .codemaps
- [ ] Consider adding an additional `llms.txt` to satisfy the new hype-train of making a `robots.txt` equivalent
- [x] Generate `*_codemap.md` for file contents and directory structure
- [x] Create separate `*_docmap.md` for documentation directories
- [x] Add repository source information to output file header
Expand Down

0 comments on commit 86c969f

Please sign in to comment.