Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update setup-workflow description in README.md #315

Merged
merged 6 commits into from
Aug 30, 2024
Merged

docs: update setup-workflow description in README.md #315

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8e754e0
docs: update setup-workflow description in README.md
kdoroszko-splunk Aug 29, 2024
7038764
chore: update README.md with proper execute-tests-on-push-to-develop
kdoroszko-splunk Aug 30, 2024
68b01a9
chore: remove tag runs from README.md
kdoroszko-splunk Aug 30, 2024
040618a
chore: remove tag runs to be aligned with the template
kdoroszko-splunk Aug 30, 2024
20c5473
Merge branch 'develop' into docs/custom-releases
kdoroszko-splunk Aug 30, 2024
bc345c8
chore: remove tag runs to be aligned with the template
kdoroszko-splunk Aug 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,14 @@ Job that is scanning PR and based on PR body or included labels defining tests t

* 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))
* 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)
* push event on branches `main`, `develop` and on `tags` (on release)
* triggering event is push to `main` branch and on `tags` (on release)
* triggering event is push to `develop` branch
* only when `execute-tests-on-push-to-develop` is set to 'true'
* when `execute-tests-on-push-to-develop` is set to 'false' tests will not be triggered
kdoroszko-splunk marked this conversation as resolved.
Show resolved Hide resolved
* triggering event is push event to `release/*` branch
* only when `execute-tests-on-push-to-release` is set to 'true'
* when `execute-tests-on-push-to-release` is set to 'false' tests will not be triggered
* triggering event is workflow_dispatch (used to create custom release version)
* schedule event (controlled from [here](https://github.com/splunk/addonfactory-repository-template/blob/main/tools/jinja_parameters.yml))
* To trigger specific test type
* 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)
Expand Down
Loading