Update dependencies and documentation

soprasteria · Apr 25, 2023 · 4c7edf3 · 4c7edf3
1 parent a4fceb2
commit 4c7edf3
Show file tree

Hide file tree

Showing 12 changed files with 123 additions and 2,164 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -14,6 +14,7 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: 18.x
+          cache: npm
           registry-url: https://registry.npmjs.org
       - run: npm ci
       - run: npm publish

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -15,7 +15,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x, 19.x]
+        node-version: [18.x, 20.x]
 
     steps:
       - uses: actions/checkout@v3

diff --git a/.gitignore b/.gitignore
@@ -2,7 +2,8 @@
 # .gitignore
 #
 
+coverage/
 node_modules/
 tmp/
-coverage/
+*.tgz
 test-results.xml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,6 @@
 
 All notable changes to this project will be documented in this file.
 
-## 0.1.0 - 2022-10-XX
+## 0.1.0 - 2023-04-25
 
 - Initial release
diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ application from DefectDojo with support for additional features:
 Install Node.js >= 18 and NPM, then run the following commands:
 
 ```bash
-npm i -g git+https://github.com/soprasteria/defectdojo-report.git
+npm i -g defectdojo-report
 defectdojo-report [options]
 ```
 
@@ -46,7 +46,7 @@ defectdojo-report                                          \
   --token "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"       \
   --product "product-name" --engagement "engagement-name"  \
   --status "active,!out_of_scope"                          \
-  --output "./secdebt"     --formats "csv,html"            \
+  --output "./secdebt"     --format "csv,html"             \
   --config "./config.json"
 ```
 

diff --git a/README_fr.md b/README_fr.md
@@ -24,7 +24,7 @@ additionnelles :
 Installer Node.js >= 18 et NPM puis exécuter les commandes suivantes :
 
 ```bash
-npm i -g git+https://github.com/soprasteria/defectdojo-report.git
+npm i -g defectdojo-report
 defectdojo-report [options]
 ```
 
@@ -48,7 +48,7 @@ defectdojo-report                                          \
   --token "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"       \
   --product "product-name" --engagement "engagement-name"  \
   --status "active,!out_of_scope"                          \
-  --output "./secdebt"     --formats "csv,html"            \
+  --output "./secdebt"     --format "csv,html"             \
   --config "./config.json"
 ```