Skip to content

Commit 2acc474

Browse files
committed
Update README.md
1 parent 78f8843 commit 2acc474

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
11
# RunScriptPlugin
22

3-
A description of this package.
3+
SwiftPackage Plugin for executing arbitrary ShellScript.
4+
5+
6+
## Usage
7+
Place the file named `.runscript.yml` in the root of the project.
8+
Write the shell script you want to run in this file.
9+
10+
The format is as follows.
11+
12+
```yaml
13+
prebuild: # prebuildCommand
14+
- name: "Hello"
15+
script: "echo Hello" # Write scripts directly
16+
- name: "Show current path"
17+
script: "pwd"
18+
- name: "Write file"
19+
script: "echo Hello >> test.txt"
20+
- name: "SwiftLint"
21+
launchPath: "/bin/bash" # bash, zsh, etc. can be specified
22+
script: "swiftlint lint --fix"
23+
24+
- name: "Update schema"
25+
file: "update_schema.sh" # Execute .sh file
26+
27+
build: # build Command
28+
- name: "Hello"
29+
script: "echo Hello"
30+
31+
```

0 commit comments

Comments
 (0)