From e6519c2ab8b526a21486effb360b8d8ec824e712 Mon Sep 17 00:00:00 2001 From: Manuele Simi Date: Sun, 14 Feb 2021 22:18:18 -0500 Subject: [PATCH] Update README with information about how to generate the repo list. --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2859492..522a60f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,26 @@ Actions for the gCubeActions Pipeline -- -Container for Actions executed with the gCubeActionExecutor pipeline. \ No newline at end of file +Container for Actions executed with the gCubeActionExecutor pipeline. + +## List of Repositories + +Each action is executed on a list of repositories. The expected format of the file with the list on repo name per file. + +For example: +```` +repo_name1 +repo_name2 +repo_name3 +... +```` +The URL of the Gitea organization where to find these repositories is passed as parameters of the _gCubeActionExecutor_ +pipeline. + +## How to Generate the List +The script generateRepoList.sh can be executed any time to generate an up-to-date list +of repositories in the _gCubeSystem_ organization. If a different organization has to be scanned, we can easily change +the scrip tor make it parametric. + +The output of the script is a file named gCubeSystem_all_sorted_$timestamp.txt. +The list in the output file is alphabetically ordered. \ No newline at end of file