Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Script to add available scripts in README.md #19

Open
vvasc opened this issue Sep 10, 2021 · 4 comments
Open

Script to add available scripts in README.md #19

vvasc opened this issue Sep 10, 2021 · 4 comments
Labels
good first issue Good for newcomers

Comments

@vvasc
Copy link
Collaborator

vvasc commented Sep 10, 2021

Motivation

We want to have a process to add a list of our scripts in the README.md automatically on merge on the main branch.

Expected Changes

  • Create a new script and add it to ScriptsConfiguration
  • This script needs to have the capability to read the ScriptsConfiguration and get two kinds of scripts from there (INTERNAL and NOT INTERNAL) using a flag, and write them in our README.md
  • Format the message in our READM.md to be readable
  • We should remove the image that describes our scripts from README.md
  • We should have a 100% coverage test on it
  • We should trigger this script on merge on the main branch using the CI. It should be done in another PR [see https://github.com/chore(rebase-action): adds a Github Action to enable rebase with a co… #17]
@vvasc
Copy link
Collaborator Author

vvasc commented Sep 10, 2021

@rodbecc @thoffart any thoughts?

@rodbecc
Copy link
Owner

rodbecc commented Sep 10, 2021

  • Create a new script and add it to import maps

import_map is a json. I suppose you meant velociraptor.ts?

  • This script needs to have the capability to read the import maps file and get two kinds of scripts from there (INTERNAL and NOT INTERNAL) by some flag, and write them in a fancy way in our README.md

I suppose you meant velociraptor.ts here too.

  • We should trigger this script on merge on the main branch

I suggest to do this in a separate PR. Since README.md is a versioned file, our CI should be able to do a commit too, and I guess it would be nice to limit the scope range to the functionality at this moment. What do you think about it?

@AngeloBonini
Copy link
Collaborator

can I take this one?

@rodbecc
Copy link
Owner

rodbecc commented Sep 11, 2021

Sure!

@rodbecc rodbecc added the good first issue Good for newcomers label Sep 13, 2021
@rodbecc rodbecc assigned rodbecc and unassigned rodbecc Oct 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants