Skip to content

Commit 49d4544

Browse files
committed
docs: update roadmap
1 parent 3c9e930 commit 49d4544

File tree

4 files changed

+33
-1
lines changed

4 files changed

+33
-1
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ jobs:
6363
llm-provider: openai # or 'gemini'
6464
```
6565
66+
See the [examples](examples/) directory for a complete workflow configuration.
67+
6668
Set `OPENAI_API_KEY` or `GEMINI_API_KEY` secrets based on your chosen provider.
6769

6870
### 2. Run the CLI locally

ROADMAP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ A smart GitHub Action that detects, classifies, and transforms inline TODOs into
6969
> Foster an active ecosystem and support network.
7070
7171
- [x] Contributor guidelines and code of conduct
72-
- [ ] Example workflows and tutorials
72+
- [x] Example workflows and tutorials
7373
- [ ] Discussion board or Discord for support
7474
- [ ] Regular release announcements
7575

examples/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Example Workflows
2+
3+
This directory contains sample configurations demonstrating how to use **smart-todo-action** in your own projects.
4+
5+
- [`todo.yml`](todo.yml) – Minimal workflow that installs dependencies and runs the action on each push to `main`.
6+
7+
Feel free to copy and adapt these files to suit your needs.

examples/todo.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Smart TODO Action Example
2+
3+
on:
4+
push:
5+
branches: [main]
6+
7+
jobs:
8+
smart-todo:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
issues: write
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Setup Node.js
15+
uses: actions/setup-node@v4
16+
with:
17+
node-version: 20
18+
- run: yarn install
19+
- run: yarn prepare
20+
- name: Run Smart TODO Action
21+
uses: DiogoRibeiro7/smart-todo-action@v1
22+
with:
23+
repo-token: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)