chore: release v5.38.0 (#1058)

.github/CODEOWNERS

@@ -1,4 +1,11 @@
-* @artemrys
-/splunk_add_on_ucc_framework/commands/openapi_generator/ @hsekowski-splunk
-/splunk_add_on_ucc_framework/schema/schema.json @artemrys @vtsvetkov-splunk
-/ui/ @vtsvetkov-splunk
+*                                                   @splunk/ucc-developers
+
+/ui/                                                @splunk/ucc-ui-developers
+*.ts                                                @splunk/ucc-ui-developers
+*.tsx                                               @splunk/ucc-ui-developers
+
+*.py                                                @splunk/ucc-be-developers
+/tests                                              @splunk/ucc-be-developers
+/splunk_add_on_ucc_framework                        @splunk/ucc-be-developers
+
+/splunk_add_on_ucc_framework/schema/schema.json     @splunk/ucc-developers

.github/actions/cached-ui-deps/action.yml

@@ -15,7 +15,7 @@ runs:
       run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
       shell: bash
     - name: Cache Dependencies
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       id: yarn-cache
       with:
         path: ${{ steps.yarn-cache-dir-path.outputs.dir }}

.github/workflows/build-test-release.yml

@@ -94,10 +94,13 @@ jobs:
         with:
           name: UCC-UI-build
           path: built-ui/
+
       - uses: actions/download-artifact@v4
+        if: "! github.event.pull_request.head.repo.fork "
         with:
           name: THIRDPARTY
       - run: cp -f THIRDPARTY NOTICE
+        if: "! github.event.pull_request.head.repo.fork "
       - run: curl -sSL https://install.python-poetry.org | python3 - --version 1.5.1
       - run: poetry install
       - name: Check docs
@@ -282,7 +285,7 @@ jobs:
           poetry install
           mkdir tests/packaged
           poetry run ucc-gen package --path tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample -o tests/packaged
-      - uses: splunk/appinspect-cli-action@v2.0
+      - uses: splunk/appinspect-cli-action@v2.2
         with:
           app_path: tests/packaged
           included_tags: ${{ matrix.tags }}
@@ -301,6 +304,7 @@ jobs:
       - semgrep
       - pre-commit
     runs-on: ubuntu-latest
+    if: "! github.event.pull_request.head.repo.fork "
     steps:
       - uses: actions/checkout@v4
         with:

.github/workflows/build-ui.yml

@@ -26,6 +26,8 @@ jobs:
         run: yarn run lint
       - name: Unit test
         run: yarn run test
+      - name: Validate storybook build
+        run: yarn run build-storybook
       - name: Build UCC UI
         run: yarn run build
       - name: List deps into dependencies.txt

docs/advanced/custom_warning.md

@@ -0,0 +1,34 @@
+This feature allows us to pass broarder description on Input and Configuration page displayed under main description.
+
+### Warning Properties
+
+| Property | Type   | Description                               |
+| -------- | ------ | ----------------------------------------- |
+| create   | object | Warning object definition for create form |
+| edit     | object | Warning object definition for edit form   |
+| clone    | object | Warning object definition for clone form  |
+| config   | object | Warning object definition for config form |
+
+### Warning Object Properties
+
+| Property                                         | Type    | Description                                                                                 |
+| ------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------- |
+| message<span class="required-asterisk">\*</span> | string  | Text used for that description, you can put \n to add a breakline                           |
+| alwaysDisplay                                    | boolean | Force warning to be always displayed, even after input changes. Default value is **false**. |
+
+### Usage
+
+```json
+"warning": {
+    "create": {
+        "message": "Some warning for create form",
+        "alwaysDisplay": true
+    },
+    "edit": {
+        "message": "Some warning for edit form "
+    },
+    "clone": {
+        "message": "Some warning for clone form"
+    }
+},
+```

docs/advanced/oauth_support.md

@@ -16,6 +16,9 @@ Auth can be used inside the entity tag. Use `type: "oauth"` in the entity list a
         - `client_secret` this is client secret for the your app for which you want auth
         - `redirect_url` this will show redirect url which needs to be put in app's redirect url.
         - `endpoint` this will be endpoint for which we want to build oauth support. For example for salesforce that will be either "login.salesforce.com" or "test.salesforce.com" or any other custom endpoint.
+          - there is also a possibility to specify separate endpoints for authorize and token, to do that instead single 'endpoint' field use two separate ones:
+            - `endpoint_authorize` - to specify the endpoint used for authorization ie. login.salesforce.com
+            - `endpoint_token` - to specify the endpoint used for token acqusition ie. api.login.salesforce.com
     - `auth_code_endpoint` this must be present and its value should be endpoint value for getting the auth_code using the app. If the url to get auth_code is https://login.salesforce.com/services/oauth2/authorize then this will have value /services/oauth2/authorize
     - `access_token_endpoint` this must be present and its value should be endpoint value for getting access_token using the auth_code received. If the url to get access token is https://login.salesforce.com/services/oauth2/token then this will have value /services/oauth2/token
     - `auth_label` this allow user to have custom label for Auth Type dropdown

docs/configurations.md

@@ -1,12 +1,14 @@
-`Configuration` tab can have multiple subtabs, for example, a tab for account configuration (Use to configure the account by adding account credentials), proxy configuration and logging level configuration.
+The `Configuration` tab can have multiple subtabs, for example, a tab for
+account configuration (to configure the account by adding account credentials),
+proxy configuration and logging level configuration.
 
 ### Configuration Properties
 
 | Property                                                          | Type   | Description                                             |
 | ----------------------------------------------------------------- | ------ | ------------------------------------------------------- |
 | title<span class="required-asterisk">\*</span>                    | string | -                                                       |
 | description                                                       | string | To provide a brief summary of an configuration page.    |
-| [subDescription](../advanced/sub_description)                     | object | To provide broader description of an configuration page |
+| [subDescription](./advanced/sub_description)                     | object | To provide broader description of an configuration page |
 | [tabs](#tabs-properties)<span class="required-asterisk">\*</span> | array  | To specify a list of tab.                               |
 
 ### Tabs properties
@@ -20,7 +22,7 @@
 | style                                                        | string | By specifying this property in the global config file, the forms can either be opened as a new page or in a dialog. <br>Supported values are "page" or "dialog". <br> Default value is **dialog**. |
 | options                                                      | object | This property allows you to enable the [saveValidator](../advanced/save_validator) feature.                                                                                                        |
 | hook                                                         | object | It is used to add custom behaviour to forms. Visit the [Custom Hook](../custom_ui_extensions/custom_hook) page to learn more.                                                                      |
-| warning                                                      | object | It is used to add custom warning message for each of modes ('create', 'edit', 'config', 'clone'), message is displayed on form                                                                     |
+| [warning](./advanced/custom_warning.md)                      | object | It is used to add custom warning message for each of modes ('create', 'edit', 'config', 'clone'), message is displayed on form                                                                     |
 | conf                                                         | string | TBD                                                                                                                                                                                                |
 | restHandlerName                                              | string | TBD                                                                                                                                                                                                |
 | restHandlerModule                                            | string | TBD                                                                                                                                                                                                |
@@ -29,24 +31,24 @@
 
 ### Usage
 
-```
+```json
 "configuration": {
     "title": "Configuration",
     "description": "Set up your add-on",
     "tabs": [
         {
             "name": "account",
-            "title": "Account"
+            "title": "Account",
             "table": {},
             "entity": []
         },
         {
             "name": "proxy",
-            "title": "Proxy"
+            "title": "Proxy",
             "entity": [],
             "options": {
                 "saveValidator": ""
-            },
+            }
         }
     ]
 }

docs/dashboard.md

@@ -78,7 +78,7 @@ Executes the following search:
 
 ```
 index=_internal source=*<addon_name>* action=events_ingested
-| timechart avg(n_events) by sourcetype_ingested
+| timechart sum(n_events) by sourcetype_ingested
 ```
 
 > Note: <addon_name> is being replaced by the actual value during the build time.

docs/inputs/index.md

@@ -29,7 +29,7 @@ Developers are required to add services in the global config file to create a ne
 | style                                                        | string | By specifying this property in the global config file, the forms can either be opened as a new page or in a dialog. <br>Supported values are "page" or "dialog". <br> Default value is **dialog**. |
 | options                                                      | object | This property allows you to enable the [saveValidator](../advanced/save_validator) feature.                                                                                                        |
 | hook                                                         | object | It is used to add custom behaviour to forms. Visit the [Custom Hook](../custom_ui_extensions/custom_hook) page to learn more.                                                                      |
-| warning                                                      | object | It is used to add custom warning message for each of modes ('create', 'edit', 'config', 'clone'), message is displayed on form                                                                     |
+| [warning](../advanced/custom_warning.md)                      | object | It is used to add custom warning message for each of modes ('create', 'edit', 'config', 'clone'), message is displayed on form                                                                     |
 | [subDescription](../advanced/sub_description)                | object | To provide broader description of an inputs page                                                                                                                                                   |
 | conf                                                         | string | TBD                                                                                                                                                                                                |
 | restHandlerName                                              | string | TBD                                                                                                                                                                                                |

docs/quickstart.md

@@ -121,6 +121,11 @@ It takes the following parameters:
 * `-v` / `--verbose` - [optional] show detailed information about
     created/copied/modified/conflict files after build is complete.
     This option is in experimental mode. Default: `False`.
+* `--pip-version` - [optional] pip version that will be used to install python libraries. Default: `latest`.
+* `--pip-legacy-resolver` - [optional] Use old pip dependency resolver by adding flag '--use-deprecated=legacy-resolver' 
+  to pip install command. Default: `False`. PLEASE NOTE: this flag is deprecated and will be removed from pip in the future.
+Instead of using this flag, the correct solution would be to fix the packages your project depends on to work properly with the new resolver.
+Additionally, please note that this flag is not compatible with pip version `23.2`, use `23.2.1` instead. 
 
 #### Verbose mode
 

docs/uccignore.md

@@ -5,4 +5,28 @@ add-on recursively overrides the output folder.
 
 It is expected to be placed in the same folder as `globalConfig` file to have effect.
 
-You will see a warning message in case ignored file is not found in the output folder.
+Uccignore supports wildcard expressions, thanks to which we can find all files matching a specific pattern.
+
+e.g. for given file structure 
+
+```
+...
+└── lib
+    └── 3rdparty
+    │   ├── linux
+    │   ├   └── pycache.pyc
+    │   ├── linux_with_deps
+    │   ├   └── pycache.pyc
+    │   └── windows
+    │       └── pycache.pyc
+    └── requests
+    │       └── pycache.pyc
+    └── urllib
+            └── pycache.pyc
+```  
+
+we can remove all `.pyc` files by adding `lib/**/pycache.pyc` to the .uccignore file. 
+If we want to remove all `.pyc` files just from the `3rdparty` directory, we need to change pattern to `lib/3rdparty/**/pycache.pyc`.
+If we want to remove only for one specific platform, we need to provide the exact path e.g. **`lib/3rdparty/windows/pycache.pyc`**.
+
+In case no file is found for the specified pattern, you will see an appropriate warning message.

mkdocs.yml

@@ -64,6 +64,7 @@ nav:
     - Save Validator: "advanced/save_validator.md"
     - OS-dependent libraries: "advanced/os-dependent_libraries.md"
     - Sub Description: "advanced/sub_description.md"
+    - Custom Warning: "advanced/custom_warning.md"
   - Troubleshooting: "troubleshooting.md"
   - Contributing: "contributing.md"
   - Changelog: "CHANGELOG.md"

renovate.json

@@ -15,11 +15,17 @@
     "every 2 weeks on Sunday"
   ],
   "packageRules": [
+    {
+      "description": "Separate npm and poetry dependencies",
+      "matchPackagePatterns": ["*"],
+      "groupName": "{{manager}}"
+    },
     {
       "matchPackageNames": ["urllib3"],
       "allowedVersions": "<2.0.0"
     },
     {
+      "description": "Ignore packages that needs for SUI",
       "matchManagers": [
         "npm"
       ],
@@ -52,19 +58,28 @@
       "enabled": false
     },
     {
+      "description": "Ignore msw-storybook-addon since they bumps incorrectly while canary version is using",
       "matchManagers": [
         "npm"
       ],
       "matchPackageNames": [
         "msw-storybook-addon"
       ],
-      "allowedVersions": "!/next|canary/"
+      "enabled": false
     },
     {
+      "description": "Update package.json versions together with yarn.lock",
       "matchManagers": [
         "npm"
       ],
       "rangeStrategy": "bump"
+    },
+    {
+      "description": "Ignore NodeJS",
+      "matchPackageNames": ["node"],
+      "matchManagers": ["npm"],
+      "matchDepTypes": [ "engines" ],
+      "enabled": false
     }
   ]
 }