diff --git a/.github/workflows/run_tests.yml b/.github/workflows/run_tests.yml index d5ea8c6..d216afb 100644 --- a/.github/workflows/run_tests.yml +++ b/.github/workflows/run_tests.yml @@ -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: diff --git a/.github/workflows/todo.yml b/.github/workflows/todo.yml index dbd1251..687c75e 100644 --- a/.github/workflows/todo.yml +++ b/.github/workflows/todo.yml @@ -1,8 +1,9 @@ name: Smart TODO Tracker on: - push: + pull_request: branches: [main] + types: [closed] workflow_dispatch: inputs: @@ -42,6 +43,7 @@ on: jobs: smart-todo: + if: github.event.pull_request.merged == true runs-on: ubuntu-latest permissions: contents: write diff --git a/CHANGELOG.md b/CHANGELOG.md index 47cf49c..97fb33f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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). diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..023459e --- /dev/null +++ b/CITATION.cff @@ -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: "dfr@esmad.ipp.pt" diff --git a/README.md b/README.md index 9a74a6c..6067243 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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. + diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..13d9968 --- /dev/null +++ b/TODO.md @@ -0,0 +1,8 @@ +# Personal Information + +- **Name:** Diogo Ribeiro +- **Username:** DiogoRibeiro7 +- **Personal email:** diogo.debastos.ribeiro@gmail.com +- **Professional email:** dfr@esmad.ipp.pt +- **Affiliation:** ESMAD - Instituto Politécnico do Porto +- **ORCID:** https://orcid.org/0009-0001-2022-7072 diff --git a/action.yml b/action.yml index 9747974..405e32d 100644 --- a/action.yml +++ b/action.yml @@ -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: diff --git a/package.json b/package.json index 649c408..b1e9d98 100644 --- a/package.json +++ b/package.json @@ -22,7 +22,7 @@ "llm", "automation" ], - "author": "", + "author": "Diogo Ribeiro ", "license": "MIT", "dependencies": { "@actions/core": "^1.10.0",