You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-1Lines changed: 36 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ jobs:
14
14
- uses: actions/checkout@v2
15
15
- uses: mcbeet/check-commands@v1
16
16
with:
17
-
source: foo.mcfunction
17
+
source: path/to/my_data_pack
18
18
```
19
19
20
20
## Usage
@@ -28,6 +28,41 @@ This github action installs [`mecha`](https://github.com/mcbeet/mecha) in an iso
28
28
| `minecraft` | defaults to `1.17` | The version of minecraft to use for checking commands |
29
29
| `log` | defaults to `WARNING` | The output log level |
30
30
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
+
31
66
## Contributing
32
67
33
68
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