add new environment variable variable description in github actions

SciCatProject · Dec 16, 2024 · 8bad5cb · 8bad5cb
1 parent 9e4aade
commit 8bad5cb
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/.github/workflows/release-and-publish-sdk.yml b/.github/workflows/release-and-publish-sdk.yml
@@ -112,6 +112,8 @@ jobs:
         env:
           MONGODB_URI: "mongodb://localhost:27017/scicat"
           JWT_SECRET: thisIsTheJwtSecret
+          # It disables the content property on some of the endpoints as the sdk generator complains about it.
+          # We want to keep it when the app is running to improve the swagger documentation and usage.
           SDK_PACKAGE_SWAGGER_HELPERS_DISABLED: true
         run: |
           npm install -g wait-on && npm install

diff --git a/.github/workflows/upload-sdk-artifact.yml b/.github/workflows/upload-sdk-artifact.yml
@@ -33,6 +33,8 @@ jobs:
         env:
           MONGODB_URI: "mongodb://localhost:27017/scicat"
           JWT_SECRET: thisIsTheJwtSecret
+          # It disables the content property on some of the endpoints as the sdk generator complains about it.
+          # We want to keep it when the app is running to improve the swagger documentation and usage.
           SDK_PACKAGE_SWAGGER_HELPERS_DISABLED: true
         run: |
           npm install -g wait-on && npm install