From 084ec4c2ce92977897239714f0b1048e2b9ca836 Mon Sep 17 00:00:00 2001 From: Shakar Bakr <5h4k4r.b4kr@gmail.com> Date: Sun, 15 Jun 2025 13:59:49 +0300 Subject: [PATCH] Remove outdated sections from README.md regarding action behavior on first and subsequent runs, streamlining documentation for clarity and relevance. Signed-off-by: Shakar Bakr <5h4k4r.b4kr@gmail.com> --- README.md | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/README.md b/README.md index af6ee7c..1f344c2 100644 --- a/README.md +++ b/README.md @@ -134,19 +134,6 @@ Install the GitHub App on both: - The source repository (where your code/TODOs are) - The target repository (where issues will be created) -## How It Works - -### First Run -When you first add this action to a repository with existing TODOs: -- With `fetch-depth: 0`, the action has access to full git history -- It compares against an empty tree to treat all files as "new" -- **All existing TODOs** in your codebase will be converted to issues - -### Subsequent Runs -- Only processes TODOs that were added, modified, or removed in the current push -- Updates existing issues when TODOs are modified -- Closes issues when TODOs are removed (if `CLOSE_ISSUES` is enabled) - ## Examples ### Same Repository (Simple) @@ -162,8 +149,6 @@ When you first add this action to a repository with existing TODOs: APP_ID: ${{ secrets.TODO_APP_ID }} PRIVATE_KEY: ${{ secrets.TODO_PRIVATE_KEY }} OWNER: "myorg" - AUTO_ASSIGN: "true" - CLOSE_ISSUES: "false" ``` ## TODO Options