Skip to content

Commit 5bec64e

Browse files
committed
add some information how to run markdown tests with a different runtime
Signed-off-by: Filinto Duran <[email protected]>
1 parent a4870a9 commit 5bec64e

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,12 +120,20 @@ tox -e type
120120

121121
8. Run examples
122122

123-
The tests in examples are using Mechanical Markdown (MM) from https://github.com/dapr/mechanical-markdown.
124-
125123
```bash
126124
tox -e examples
127125
```
128126

127+
[Dapr Mechanical Markdown](https://github.com/dapr/mechanical-markdown) is used to test the examples.
128+
129+
If you need to run the examples against a development version of the runtime, you can use the following command:
130+
- Get your daprd runtime binary from [here](https://github.com/dapr/dapr/releases) for your platform.
131+
- Copy the binary to a folder, for example `examples/.dapr/bin/` directory.
132+
- In your example README, change the `dapr run` command and add a line `--runtime-path ./examples \`.
133+
- Copy a dapr config file `config.yaml` file to the `examples/.dapr` directory. This file is usually in your $(HOME)/.dapr directory if you had installed dapr cli before.
134+
- Now you can run the example with `tox -e examples`.
135+
136+
129137
## Documentation
130138

131139
Documentation is generated using Sphinx. Extensions used are mainly Napoleon (To process the Google Comment Style) and Autodocs (For automatically generating documentation). The `.rst` files are generated using Sphinx-Apidocs.

examples/conversation/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ The Conversation API supports real LLM providers including:
2020
```
2121

2222
2. **Run the simple conversation on the Alpha V1 version (dapr 1.15)**
23+
24+
This is a basic example that uses the Conversation API to get a response from a bot.
25+
It also uses the `echo` provider that just echoes back the message.
26+
In the echo provider, a multi-input message is returned as a single output separated by newlines.
27+
2328
<!-- STEP
2429
name: Run Conversation Alpha V1
2530
expected_stdout_lines:

0 commit comments

Comments
 (0)