Skip to content

Commit

Permalink
Merge pull request #291 from weaviate/kavirajk/add-workflow-instruction
Browse files Browse the repository at this point in the history
doc(README): Update how to run the Github action workflow
  • Loading branch information
kavirajk authored Jan 28, 2025
2 parents 4c77651 + aaaa100 commit d42620a
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,18 @@ simple bash scripts. You can find the scripts in the root folder, such as
`./import_while_crashing.sh` and `./compare_recall_after_restart.sh`. Or simply
check the Github actions YAML files for examples.

## Links
### Run the Github action workflow
You can also run the chaos pipeline for your public weaviate image. Follow the steps below.

> NOTE: You should have right permission to trigger Github action workflow. Usually available for Weaviate core developers
1. Go to [Test Matrix](https://github.com/weaviate/weaviate-chaos-engineering/actions/workflows/matrix.yaml) workflow
2. Click on "Run workflow"
3. Choose `main` branch
4. Enter the public docker image of your weaviate. (e.g: `semitechnologies/weaviate:1.25.29-6b28b2813`)
5. Start and observe the workflow

## Links

- [Weaviate Main Repo](https://github.com/semi-technologies/weaviate).
- [Documentation](https://weaviate.io/developers/weaviate/current/client-libraries/javascript.html).
Expand Down

0 comments on commit d42620a

Please sign in to comment.