Skip to content

Commit e207a93

Browse files
committed
update docs about how to run the docker action locally
1 parent eee0ca4 commit e207a93

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/dev-notes/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,15 @@
4747
The steps below show how to run the Docker container action against a set of test data provided by the repo. However you can follow the same steps and provide any data you wish to test.
4848

4949
1) Clone the repo and browse to the repo's directory.
50-
2) Run `docker build -t mlc-log-parser .`
51-
3) Run the docker container and pass at least the required inputs by executing:
50+
2) Create an empty file named `github-step-output.txt` that will store the output of the action. This will only contain the output of the action when the `output` actions's input parameter of the action is set to `step-json` or `step-md`. To create an empty file you can do something like `echo $null >> github-step-output.txt`.
51+
3) Run `docker build -t mlc-log-parser .`
52+
4) Run the docker container and pass at least the required inputs by executing:
5253

5354
```
54-
docker run --rm -v ${pwd}:/workspace --workdir /workspace mlc-log-parser `
55+
docker run --rm --env GITHUB_OUTPUT=/workspace/github-step-output.txt `
56+
-v ${pwd}:/workspace `
57+
-v ${pwd}/github-step-output.txt:/workspace/github-step-output.txt `
58+
--workdir /workspace mlc-log-parser `
5559
parse-log `
5660
--auth-token <github token> `
5761
--repo <repo> `

0 commit comments

Comments
 (0)