Skip to content

Commit 5f44b3a

Browse files
Merge branch 'develop' into feat/custom-search-command
2 parents afc6bbb + ff0a28e commit 5f44b3a

File tree

72 files changed

+3288
-1267
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+3288
-1267
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ jobs:
7171
runs-on: ubuntu-22.04
7272
steps:
7373
- uses: actions/checkout@v4
74-
- uses: apache/skywalking-eyes@v0.6.0
74+
- uses: apache/skywalking-eyes@v0.7.0
7575

7676
build-ui:
7777
name: Build UCC UI
@@ -472,6 +472,9 @@ jobs:
472472
- pre-commit
473473
- all-checks
474474
runs-on: ubuntu-22.04
475+
permissions:
476+
id-token: write
477+
contents: read
475478
if: "! github.event.pull_request.head.repo.fork "
476479
steps:
477480
- uses: actions/checkout@v4

.github/workflows/npm-publish.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,12 @@ jobs:
3939
uses: ./.github/actions/cached-ui-deps
4040

4141
- name: Bump version
42+
4243
run: |
4344
if [ "${{ github.event.inputs.version_type }}" = "prerelease" ]; then
4445
npm version prerelease --preid=dev --no-git-tag-version
4546
else
46-
npm version ${{ github.event.inputs.version_type }} --no-git-tag-version
47+
npm version ${{ github.event.inputs.version_type }} --no-git-tag-version --allow-same-version
4748
fi
4849
4950
- name: Publish NPM package

.github/workflows/ta-tests.yml

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
name: TAs Regression Test
2+
3+
on:
4+
push:
5+
branches:
6+
- develop
7+
- main
8+
pull_request:
9+
branches:
10+
- "**"
11+
workflow_dispatch:
12+
inputs:
13+
target_repo:
14+
description: "Target repository"
15+
required: false
16+
default: ""
17+
target_branch:
18+
description: "Target branch"
19+
required: false
20+
default: "main"
21+
22+
jobs:
23+
build-ucc:
24+
runs-on: ubuntu-22.04
25+
steps:
26+
- name: Checkout UCC Framework Repository
27+
uses: actions/checkout@v4
28+
with:
29+
path: UCC
30+
31+
- name: Set up Python
32+
uses: actions/setup-python@v5
33+
with:
34+
python-version: "3.7"
35+
36+
- name: Install Poetry
37+
run: pip install poetry==1.5.1
38+
39+
- name: Build UCC Framework Package
40+
working-directory: UCC
41+
run: |
42+
poetry install
43+
poetry build
44+
45+
- name: Upload UCC Artifact
46+
uses: actions/upload-artifact@v4
47+
with:
48+
name: ucc-package-whl
49+
path: UCC/dist/*.whl
50+
51+
test-addons:
52+
needs: build-ucc
53+
strategy:
54+
matrix:
55+
target_repo:
56+
- splunk/splunk-add-on-for-amazon-web-services
57+
- splunk/splunk-add-on-for-google-cloud-platform
58+
- splunk/splunk-add-on-for-google-workspace
59+
- splunk/splunk-add-on-for-microsoft-cloud-services
60+
- splunk/splunk-add-on-for-microsoft-office-365
61+
- splunk/splunk-add-on-for-salesforce
62+
- splunk/splunk-add-on-for-servicenow
63+
- splunk/splunk-add-on-for-mysql
64+
continue-on-error: true
65+
runs-on: ubuntu-22.04
66+
steps:
67+
- name: Checkout Target Add-on Repository
68+
if: ${{ github.event_name == 'push' || github.event.inputs.target_repo == '' }}
69+
uses: actions/checkout@v4
70+
with:
71+
repository: ${{ matrix.target_repo }}
72+
path: TA
73+
token: ${{ secrets.GH_TOKEN_ADMIN }}
74+
75+
- name: Checkout Target Add-on Repository (manual)
76+
if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.target_repo != '' }}
77+
uses: actions/checkout@v4
78+
with:
79+
repository: ${{ github.event.inputs.target_repo }}
80+
ref: ${{ github.event.inputs.target_branch }}
81+
path: TA
82+
token: ${{ secrets.GH_TOKEN_ADMIN }}
83+
84+
- name: Set up Python
85+
uses: actions/setup-python@v5
86+
with:
87+
python-version: "3.7"
88+
89+
- name: Install Poetry
90+
run: pip install poetry==1.5.1
91+
92+
- name: Download UCC Artifact
93+
uses: actions/download-artifact@v4
94+
with:
95+
name: ucc-package-whl
96+
path: UCC
97+
98+
- name: Install Dependencies in Target Add-on
99+
working-directory: TA
100+
run: |
101+
UCC_WHL=$(ls ../UCC/*.whl)
102+
# https://github.com/python-poetry/poetry/issues/7491#issuecomment-1423763839
103+
git config --global --add url."https://${{ secrets.GH_TOKEN_ADMIN }}@github.com".insteadOf https://github.com
104+
git config --global --add url."https://${{ secrets.GH_TOKEN_ADMIN }}@github.com".insteadOf ssh://git@github.com
105+
poetry add ../UCC/$UCC_WHL --group dev
106+
poetry add splunktaucclib@latest
107+
mkdir -p package/lib
108+
poetry export --without-hashes -o package/lib/requirements.txt
109+
110+
- name: Run ucc-gen build in Target Add-on
111+
working-directory: TA
112+
run: |
113+
poetry run ucc-gen build

NOTICE

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77

88
The following 3rd-party software packages may be used by or distributed with addonfactory-ucc-generator. Any information relevant to third-party vendors listed below are collected using common, reasonable means.
99

10-
Date generated: 2025-2-18
10+
Date generated: 2025-2-20
1111

12-
Revision ID: ae02103b55ce164a6983a0f397578c049fc6bd9c
12+
Revision ID: 6b069ec8054e66a0cbb7f6c1415ce03cbafbe4b5
1313

1414
================================================================================
1515
================================================================================
@@ -28168,4 +28168,4 @@ either expressed or implied, of the FreeBSD Project.
2816828168
--------------------------------------------------------------------------------
2816928169
--------------------------------------------------------------------------------
2817028170

28171-
Report Generated by FOSSA on 2025-2-18
28171+
Report Generated by FOSSA on 2025-2-20

docs/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Changelog
22

3+
## [5.58.1](https://github.com/splunk/addonfactory-ucc-generator/compare/v5.58.0...v5.58.1) (2025-02-20)
4+
5+
6+
### Bug Fixes
7+
8+
* build if "conf" param specified for a configuration tab ([#1590](https://github.com/splunk/addonfactory-ucc-generator/issues/1590)) ([6b069ec](https://github.com/splunk/addonfactory-ucc-generator/commit/6b069ec8054e66a0cbb7f6c1415ce03cbafbe4b5))
9+
310
# [5.58.0](https://github.com/splunk/addonfactory-ucc-generator/compare/v5.57.2...v5.58.0) (2025-02-18)
411

512

docs/configurations/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ proxy configuration, and logging level configuration.
3232
| [restHandlerClass](../advanced/custom_rest_handler.md) | string | It specify name of the class present in the restHandlerModule, which implements methods like handleCreate, handleEdit, handleList, handleDelete and is child class of splunktaucclib.rest_handler.admin_external.AdminExternalHandler. (Use with restHandlerModule) |
3333
| customTab | Object | This property allows you to enable the [custom tab](../custom_ui_extensions/custom_tab.md) feature. |
3434
| hideForPlatform | string | Defines for which platform element should be hidden from UI perspective. Currently only two platforms are supported `cloud` or `enterprise`. |
35+
| formTitle | string | When provided, the `formTitle` parameter will override the default modal title format of `"Add selectedTab"`. The modal will display `Add` followed by the value of formTitle, allowing for a custom, context-specific title. This customization also applies to modals for `Clone`, `Edit`, and `Delete` actions. |
3536

3637
### Tab components
3738

@@ -89,3 +90,7 @@ This is how Proxy tab looks in the UI:
8990
![image](../images/configuration/proxy_tab_with_warning.png)
9091

9192
More information about how to set Proxy tab, can be found [here](./proxy.md).
93+
94+
This is how custom header look in the UI:
95+
96+
<iframe src="/addonfactory-ucc-generator/storybook/?path=/story/pages-configurationpage--configuration-custom-header&full=1&shortcuts=false&singleStory=true"></iframe>

docs/entity/modifyFieldsOnValue.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ This feature allows to specify conditions to modify other fields based on curren
3636

3737
### Usage
3838

39+
<details>
40+
<summary>Checkbox</summary>
41+
3942
```json
4043
{
4144
"type": "checkbox",
@@ -74,6 +77,11 @@ This feature allows to specify conditions to modify other fields based on curren
7477
},
7578
```
7679

80+
</details>
81+
82+
<details>
83+
<summary>Text input</summary>
84+
7785
```json
7886
{
7987
"label": "Username",
@@ -176,3 +184,69 @@ This feature allows to specify conditions to modify other fields based on curren
176184
]
177185
},
178186
```
187+
188+
</details>
189+
190+
### Troubleshooting
191+
192+
Examples of issue you might encounter
193+
194+
<details>
195+
<summary>Usage Modification with Checkbox component</summary>
196+
197+
Make sure the fieldValue fields are declared as `1` for any `truthy`(checked) value and `0` for any `falsy`(unchecked) value as it is mapped considering those values. Checkbox by default do not have any value at all, so if you want to consider also this state use `[[any_other_value]]` as it will also consider basic state.
198+
199+
```json
200+
{
201+
"type": "checkbox",
202+
"label": "Example Checkbox",
203+
"field": "account_checkbox",
204+
"help": "This is an example checkbox for the account entity",
205+
"modifyFieldsOnValue": [
206+
{
207+
"fieldValue": 1,
208+
"fieldsToModify": [
209+
{
210+
"fieldId": "account_radio",
211+
"disabled": false
212+
},
213+
{
214+
"fieldId": "endpoint",
215+
"display": true
216+
}
217+
]
218+
},
219+
{
220+
"fieldValue": 0,
221+
"mode": "edit",
222+
"fieldsToModify": [
223+
{
224+
"fieldId": "account_radio",
225+
"disabled": true
226+
},
227+
{
228+
"fieldId": "endpoint",
229+
"display": false
230+
}
231+
]
232+
},
233+
{
234+
"fieldValue": "[[any_other_value]]",
235+
"fieldsToModify": [
236+
{
237+
"fieldId": "account_radio",
238+
"disabled": true,
239+
"display": true
240+
},
241+
{
242+
"fieldId": "endpoint",
243+
"display": true,
244+
"display": true
245+
}
246+
]
247+
}
248+
]
249+
},
250+
```
251+
252+
</details>

docs/inputs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ provided, a dropdown field will appear on the Inputs page. In contrast, a button
4444
| [restHandlerClass](../advanced/custom_rest_handler.md) | string | It specify name of the class present in the restHandlerModule, which implements methods like handleCreate, handleEdit, handleList, handleDelete and is child class of splunktaucclib.rest_handler.admin_external.AdminExternalHandler. (Use with restHandlerModule) |
4545
| hideForPlatform | string | Defines for which platform element should be hidden from UI perspective. Currently only two platforms are supported `cloud` or `enterprise`. |
4646
| disableNewInput | boolean | Specifies whether a service's new input should be disabled on creation or not. If set to `True`, any new input created from the service will remain disabled until manually enabled by the user. Default: false |
47+
| formTitle | string | When provided, the `formTitle` parameter will override the default modal title format of `"Add serviceName"`. The modal will display `Add` followed by the value of formTitle, allowing for a custom, context-specific title. This customization also applies to modals for `Clone`, `Edit`, and `Delete` actions. |
4748

4849
### Usage
4950

0 commit comments

Comments
 (0)