Skip to content

Commit ba0f4ac

Browse files
committed
Add examples
1 parent d32215a commit ba0f4ac

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
- uses: actions/checkout@v2
1515
- uses: mcbeet/check-commands@v1
1616
with:
17-
source: foo.mcfunction
17+
source: path/to/my_data_pack
1818
```
1919
2020
## Usage
@@ -28,6 +28,41 @@ This github action installs [`mecha`](https://github.com/mcbeet/mecha) in an iso
2828
| `minecraft` | defaults to `1.17` | The version of minecraft to use for checking commands |
2929
| `log` | defaults to `WARNING` | The output log level |
3030

31+
## Examples
32+
33+
Check a data pack when the `pack.mcmeta` file is at the root of the repository.
34+
35+
```yml
36+
- uses: mcbeet/check-commands@v1
37+
with:
38+
source: .
39+
```
40+
41+
Check a data pack located in the `src` directory.
42+
43+
```yml
44+
- uses: mcbeet/check-commands@v1
45+
with:
46+
source: src
47+
```
48+
49+
Check individual function files.
50+
51+
```yml
52+
- uses: mcbeet/check-commands@v1
53+
with:
54+
source: foo.mcfunction bar.mcfunction
55+
```
56+
57+
Check a data pack at the root of the repository with an explicit minecraft version.
58+
59+
```yml
60+
- uses: mcbeet/check-commands@v1
61+
with:
62+
source: .
63+
minecraft: "1.18"
64+
```
65+
3166
## Contributing
3267

3368
Contributions are welcome. Make sure to first open an issue discussing the problem or the new feature before creating a pull request. If you find a bug please try to share a link the problematic action run.

0 commit comments

Comments
 (0)