Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/run_tests.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
name: Run Tests

on:
push:
branches: [main]
pull_request:
branches: [main]
types: [closed]

jobs:
test:
if: github.event.pull_request.merged == true
runs-on: ubuntu-latest

steps:
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/todo.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
name: Smart TODO Tracker

on:
push:
pull_request:
branches: [main]
types: [closed]

workflow_dispatch:
inputs:
Expand Down Expand Up @@ -42,6 +43,7 @@ on:

jobs:
smart-todo:
if: github.event.pull_request.merged == true
runs-on: ubuntu-latest
permissions:
contents: write
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,7 @@

## TODO · performance
- Refactor this logic to improve performance (`src/testTodo.ts:2`)

---

For DOI and licensing details, see [CITATION.cff](CITATION.cff).
20 changes: 20 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
cff-version: 1.2.0
message: "If you use this software, please cite it using the metadata from this file."
title: "smart-todo-action"
version: "1.0.0"
repository-code: "https://github.com/DiogoRibeiro7/smart-todo-action"
type: software
url: "https://github.com/DiogoRibeiro7/smart-todo-action"
date-released: 2025-06-19
doi: "10.5281/zenodo.1234567"
abstract: "GitHub Action that converts TODO comments into GitHub issues with optional LLM support."
license: "MIT"
keywords:
- GitHub Action
- automation
authors:
- family-names: Ribeiro
given-names: Diogo
orcid: "https://orcid.org/0009-0001-2022-7072"
affiliation: "ESMAD - Instituto Politécnico do Porto"
email: "[email protected]"
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

A GitHub Action that scans your codebase for inline TODOs, FIXMEs, and BUG comments, and automatically creates GitHub Issues — with support for labels, metadata parsing, and semantic enrichment.

For citation information, see [CITATION.cff](CITATION.cff).

---

## 🚀 Features
Expand Down Expand Up @@ -42,10 +44,10 @@ jobs:
issues: write

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 20

Expand Down Expand Up @@ -174,3 +176,8 @@ current Git tag. It runs in CI and can be invoked locally with:
```bash
yarn check-version
```

## 📜 Citation

If you use **smart-todo-action**, please cite it using the metadata in [CITATION.cff](CITATION.cff). This file contains the DOI and author information for reference managers.

8 changes: 8 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Personal Information

- **Name:** Diogo Ribeiro
- **Username:** DiogoRibeiro7
- **Personal email:** [email protected]
- **Professional email:** [email protected]
- **Affiliation:** ESMAD - Instituto Politécnico do Porto
- **ORCID:** https://orcid.org/0009-0001-2022-7072
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: 'Smart TODO Action'
description: 'Transforma comentários TODO/FIXME/BUG do código em GitHub Issues inteligentes.'
description: 'Transforma comentários TODO/FIXME/BUG do código em GitHub Issues inteligentes. Consulte CITATION.cff para DOI e licença.'
author: 'Diogo Ribeiro'

inputs:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"llm",
"automation"
],
"author": "",
"author": "Diogo Ribeiro <[email protected]>",
"license": "MIT",
"dependencies": {
"@actions/core": "^1.10.0",
Expand Down
Loading