todo-comments.yml

name: Check TODO Comments

on:
  pull_request:

jobs:
  find-todo-comments:
    permissions:
      pull-requests: write

    runs-on: ubuntu-latest

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4

    - uses: indigo-san/todo-comments-in-pr@v1
      id: todos

    - name: Generate a summary of the tasks
      uses: actions/github-script@v7
      id: summary
      with:
        result-encoding: string
        script: |
          const tasks = JSON.parse(String.raw`${{ steps.todos.outputs.tasks }}`);
          let body = tasks.map(task => `https://github.com/${{ github.repository }}/blob/${{ github.sha }}/${task.fileName}#L${task.startLine}-L${task.endLine}`).join('\n');

          if (tasks.length > 0) {
            body = `The following TODO comments were found:\n\n${body}`;
          } else {
            body = 'No TODO comments were found.';
          }
          return body;

    - name: Comment on the pull request
      uses: marocchino/sticky-pull-request-comment@v2
      with:
        header: todo-cooments
        recreate: true
        message: |
          ${{ steps.summary.outputs.result }}