Skip to content

Commit

Permalink
chore: docs update and prepare for testing
Browse files Browse the repository at this point in the history
  • Loading branch information
mkolasinski-splunk committed Jul 31, 2024
1 parent eee1508 commit 9ad85c1
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,12 @@ The following example configuration file indicates a version of Splunk with "MET
```
--splunkfeatures METRICS_MULTI
```

# Development flow

Once new version of Splunk or sc4s is released and PR with updates in SC4S_matrix.conf or splunk_matrix.conf is created, new configuration should be tested against TAs before the new release of action.
1. update the [action.yaml](https://github.com/splunk/addonfactory-test-matrix-action/blob/main/action.yml#L6) file - you need to configure it to use the Dockerfile directly. This ensures that the latest changes are included in the testing environment.
2. Create a PR on [addonfactory-workflow-addon-release](https://github.com/splunk/addonfactory-workflow-addon-release)
3. In this PR, modify the matrix step to reference the branch of `addonfactory-test-matrix-action` that is currently under test.
4. Execute CI for several TAs with `build-test-release` workflow referencing created branch on `addonfactory-workflow-addon-release`
5. After succesfull execution of tests, make a new fix release of `addonfactory-test-matrix-action` which will be automatically incorporated into latest `addonfactory-workflow-addon-release` workflow
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ name: "Add on factory test matrix"
description: "This tool automates the selection matrix dimensions"
runs:
using: "docker"
image: docker://ghcr.io/splunk/addonfactory-test-matrix-action/addonfactory-test-matrix-action:v2.1.4
image: Dockerfile

0 comments on commit 9ad85c1

Please sign in to comment.