IDEA: GH Action to generate tree + incorporate in repo-scaffolder

natalialuzuriaga commented 8 months ago

Is your feature request related to a problem? Please describe. Tier 3 & Tier 4 README.md includes a Repository Structure section. Currently, our users must do this manually, however this is an opportunity to automate this upon README.md file creation by creating a GitHub action that uses the tree command.

Describe the intended behavior Upon the creation of the README.md file, the repository structure is automatically generated using the tree command.

Describe the solution you'd like Create a GitHub action that uses the tree command to generate the repository structure section of the README.md.

natalialuzuriaga commented 3 months ago

07/19:

Just started!

decause-gov commented 3 months ago

7/22:

Preliminary gh-action script exists. Getting stuck on esaping newlines. Tree command has new-lines, but transferring to SED is complex.
IDEA: Ask chatgpt to write a sed/awk command to do this?
IDEA: use man tree to explore the 'graphics' options that might help with whitespace/newlines.
Goal: Ship this week!

Firebird1029 commented 3 months ago

PR ready for review here: https://github.com/DSACMS/repo-scaffolder/pull/123

decause-gov commented 3 months ago

07/26:

PR has been merged! #123 🚢 🌲

DSACMS / repo-scaffolder

IDEA: GH Action to generate tree + incorporate in repo-scaffolder #60