Skip to content

Commit 2e92f1f

Browse files
docs: update setup-workflow description in README.md (#315)
Updating README.md to be aligned with the latest changes (#309). --------- Co-authored-by: mkolasinski-splunk <105011638+mkolasinski-splunk@users.noreply.github.com>
1 parent d875027 commit 2e92f1f

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ jobs:
168168
fi
169169
;;
170170
"push")
171-
if ${{ github.ref_name == 'main' }} || ${{ github.ref_name == 'develop' }} || ${{ github.ref_type == 'tag' }} ||
171+
if ${{ github.ref_name == 'main' }} || ${{ github.ref_name == 'develop' }} ||
172172
${{ startsWith(github.ref_name, 'release/') && inputs.execute-tests-on-push-to-release == 'true' }} ; then
173173
for test_type in "${TESTSET[@]}"; do
174174
EXECUTE_LABELED["$test_type"]="true"

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,12 @@ Job that is scanning PR and based on PR body or included labels defining tests t
3737

3838
* All tests are executed by default when (controlled from [here](https://github.com/splunk/addonfactory-repository-template/blob/main/enforce/.github/workflows/build-test-release.yml))
3939
* PR target branch is `main` (unless `use_labels` label is used then specific test labels (see below) should be added to execute specific test types)
40-
* push event on branches `main`, `develop` and on `tags` (on release)
40+
* triggering event is push to `main` branch
41+
* triggering event is push to `develop` branch
42+
* triggering event is push event to `release/*` branch
43+
* only when `execute-tests-on-push-to-release` is set to 'true'
44+
* when `execute-tests-on-push-to-release` is set to 'false' tests will not be triggered
45+
* triggering event is workflow_dispatch (used to create custom release version)
4146
* schedule event (controlled from [here](https://github.com/splunk/addonfactory-repository-template/blob/main/tools/jinja_parameters.yml))
4247
* To trigger specific test type
4348
* add to PR one or multiple labels, available choices can be found [here](https://github.com/splunk/addonfactory-workflow-addon-release/blob/4f3fa4d779b6ec7649f0dc6b973eb4d68e5fcc48/.github/workflows/reusable-build-test-release.yml#L153)

0 commit comments

Comments
 (0)