If you use Todo+ for tracking your TODOs - You can use this action to automatically add them to a roadmap in your README in form of a markdown list.

Sample

Todo	Markdown

Roadmap

• Formatting:

  • Format '@done(Date)' in done tasks

• Tasks:

  • Handle due tasks
  • Handle abandoned tasks

Usage

1. Add the following segment to your README file where you want your todo to appear:

   <!-- start: readme-segment -->
   <!-- end: readme-segment -->
   

2. Click Action tab and choose Set up a workflow yourself.

3. Copy the following code into the opened file

   name: Todo+ Roadmap
   
   on:
     push:
       paths:
         - 'TODO'
     pull_request:
       paths:
         - 'TODO'
     # Allow manual trigger
     workflow_dispatch:
   
   permissions:
     contents: write
   
   jobs:
     update:
       name: Update Todo in Readme
       runs-on: ubuntu-latest
       steps:
         # Use indeedornot/todo-to-markdown@<latest-release-tag> for latest stable release
         - uses: indeedornot/todo-to-markdown@main
           with:
             # Automatic github token
             GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
             # Branch - older GitHub repositories have "master" as default branch, uncomment if that's the case
             #BRANCH: "master"

• Now every time you update your TODO file, your README will be updated with the latest todos.