robocomp/robocomp-robolab

[FEATURE]: GitHub bot to automate (Readme.md) file modification

bhav09 opened this issue · 4 comments

Is your feature request related to a problem? Please describe.
In my PR: #69 I have added a directory tree to which I was asked to suggest a solution by @orensbruli for automatically updating the directory tree in the readme.MD files once any modification is done in the repository.

I had contributed a directory tree for the detection folder, which is mentioned below:

├───activityRecognition
│   ├───dl_training
│   │   ├───experiments
│   │   │   ├───CAD-60
│   │   │   │   ├───1
│   │   │   │   │   └───HCN18
│   │   │   │   │       └───checkpoint
│   │   │   │   ├───2
│   │   │   │   │   └───HCN19
│   │   │   │   │       └───checkpoint
│   │   │   │   ├───3
│   │   │   │   │   └───HCN20
│   │   │   │   │       └───checkpoint
│   │   │   │   └───4
│   │   │   │       └───HCN19
│   │   │   │           └───checkpoint
│   │   │   └───NTU-RGB-D-CS
│   │   │       └───HCN06
│   │   │           └───checkpoint
│   │   ├───feeder
│   │   ├───model
│   │   ├───resource
│   │   │   └───NTU-RGB-D
│   │   └───utils
│   ├───etc
│   ├───src
│   │   ├───data
│   │   ├───model
│   │   └───utils
│   └───SVM_hand_crafted
│       ├───feature_extraction
│       ├───feeder
│       ├───models
│       └───support_operations
├───apriltagsComp
│   ├───etc
│   └───src
│       └───AprilTags
├───colorTraking
│   ├───etc
│   └───src
│       └───ColorDetection
├───emotionrecognition2
│   ├───assets
│   ├───CNN
│   │   ├───checkpoints
│   │   └───data
│   │       ├───angry
│   │       ├───happy
│   │       ├───neutral
│   │       ├───sad
│   │       └───surprised
│   ├───etc
│   └───src
├───extrinsic_camera_calibration
│   ├───etc
│   └───src
├───faceidentification
│   ├───assets
│   │   └───src
│   ├───etc
│   └───src
├───handDetection
│   ├───etc
│   └───src
│       ├───images
│       │   ├───depth_images
│       │   ├───masks
│       │   └───output
│       └───libs
│           └───HandDetection
│               └───resources
├───handGesture
│   ├───assets
│   ├───etc
│   └───src
├───handKeypoint
│   ├───etc
│   └───src
├───objDetection
│   ├───etc
│   └───src
├───realsensehuman
│   ├───etc
│   └───src
├───realsense_camera
│   ├───etc
│   └───src
├───simplecamerargbd_realsense
│   ├───etc
│   └───src
└───test
    ├───activityRecognitionClient
    │   ├───etc
    │   └───src
    ├───emotionrecognitionclient
    │   ├───etc
    │   └───src
    ├───faceidentificationclient
    │   ├───assets
    │   │   ├───save_model
    │   │   └───src
    │   ├───etc
    │   └───src
    └───handGestureClient
        ├───assets
        │   └───protos
        ├───etc
        └───src

Describe the solution you'd like
To update the markdown file, again and again, is quite tiresome. I would like to suggest deploying a GitHub actions bot to automatically update the markdown files once a new feature is added to the repository.

Describe alternatives you've considered
An alternative is to keep a track of all the modifications done in the features and then manually update the markdown file.

How is your investigation about this going on?

@orensbruli sir, the domain is new. There a couple of things I need to know before deploying the bot. I am investing my time in learning the tools required to build it. I am so much enticed by its use case that it intrigued me to learn more! I will raise a PR as soon as I complete implementing it.
Thanks for always being so supportive.

No problem, I'm just curious to know if it's possible to dynamically edit an md on github with the content of the own repository.

@orensbruli sir, it is definitely possible with the help of the actions bot.