Skip to content

Commit

Permalink
ReadMe improved.
Browse files Browse the repository at this point in the history
  • Loading branch information
VatsalJagani committed Mar 17, 2024
1 parent 36ec04e commit a42ff17
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/py_unit_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ jobs:
run: pytest tests --junitxml=junit/test-results.xml --cov=src --cov-config=tests/.coveragerc --cov-report=xml

- name: Adding GitHub action step summary
uses: VatsalJagani/pytest-cov-action@v0.6
uses: VatsalJagani/pytest-cov-action@v1
with:
pytest_results_file: "junit/test-results.xml"
pytest_cov_file: "coverage.xml"
# pytest_cov_file: "coverage.xml"
if: ${{ always() }}
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ def stream_events(input_script: smi.Script, inputs: smi.InputDefinition, event_w
#### to_make_permission_changes
* description: "Whether to apply file and folder permission changes according to Splunk App Inspect expectation before generating the build."
* Before you add this parameter, read the instruction from [Avoid File and Folder Permission Issue on Your App Build](#-Avoid-File-and-Folder-Permission-Issue-on-Your-App-Build) section.
* Before you add this parameter, read the instruction from [Avoid File and Folder Permission Issue on Your App Build](#avoid-file-and-folder-permission-issue-on-your-app-build) section.
* required: false
* default: false
Expand All @@ -239,7 +239,7 @@ def stream_events(input_script: smi.Script, inputs: smi.InputDefinition, event_w
#### app_utilities
* description: "Add comma separated list of utilities to use. You need to enable read and write permission for workflow to create Pull Requests. Valid options: whats_in_the_app, logger, splunk_python_sdk, common_js_utilities, ucc_additional_packaging"
* required: false
* default: "", meaning no utilities
* default: "" (meaning no utilities)
#### my_github_token
* description: "GitHub Secret Token to automatically create Pull request. (Make sure to put it in the Repo secret on GitHub as `MY_GITHUB_TOKEN` and then use it like `{{ secrets.MY_GITHUB_TOKEN }}`. Do not write it in plain text.) Only required if app_utilities is being used."
Expand Down Expand Up @@ -324,6 +324,7 @@ def stream_events(input_script: smi.Script, inputs: smi.InputDefinition, event_w
* Fix Splunk App Inspect Failure due to file permission issue. The App/Add-on build process automatically fixes that.
* App utilities added: `whats_in_the_app` (information to be added to README file about no. of alerts, dashboards, etc), `logger` (Python logger file and props.conf configs for the internal logs), `splunk_python_sdk` (Automatically upgrade Splunklib Python SDK), `common_js_utilities` (Common JS utilities file)
### v1
* GitHub App action created for Splunk Apps.
* It can generate App and Add-ons's Builds.
Expand Down

0 comments on commit a42ff17

Please sign in to comment.