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
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,15 @@
1
1
# Setup Binary Ninja action
2
2
3
-
This action installs [Binary Ninja] for testing and building both native and python plugins within Github CI. NOTE: This only supports Linux, if you want to run on windows or mac runners you will need to manually create a headless version of [Binary NInja] and pass in the `download-url`.
3
+
This action installs [Binary Ninja] for testing and building both native and python plugins within GitHub CI.
4
+
5
+
This only supports Linux, if you want to run on Windows or MACOS runners you will need to manually create a headless version of [Binary NInja] and pass in the `download-url`.
4
6
5
7
## Example usage
6
8
7
9
When using this action it should be noted that the license input should basically always be a secret.
8
10
9
11
```yaml
10
-
uses: emesare/setup-binary-ninja@v1-beta
12
+
uses: Vector35/setup-binary-ninja@v1
11
13
with:
12
14
license: '${{ secrets.BN_SERIAL }}'
13
15
```
@@ -32,11 +34,11 @@ Override the default download process. This is for advanced use cases where you
32
34
33
35
### `dev-branch`
34
36
35
-
Whether or not to use the developer branch of [Binary Ninja]. Default is `false`.
37
+
Whether to use the development branch of [Binary Ninja]. Default is `false`.
36
38
37
39
### `python-support`
38
40
39
-
Whether or not to expose [Binary Ninja] to the runners python installation, i.e. the ability to `import binaryninja` in python. Make sure you have setup python **before** this action is run. Default is `true`.
41
+
Whether or not to expose [Binary Ninja] to the runners python installation, i.e. the ability to `import binaryninja` in python. Make sure you have set up python **before** this action is run. Default is `true`.
40
42
41
43
## Outputs
42
44
@@ -48,7 +50,7 @@ The installation directory.
48
50
49
51
### Building
50
52
51
-
Github actions must not import remote packages, thus a bundler is required to pack all dependencies into a single script. To regenerate the bundle (dist/index.js) run `npm run build`.
53
+
GitHub actions must not import remote packages, thus a bundler is required to pack all dependencies into a single script. To regenerate the bundle (dist/index.js) run `npm run build`.
Oddly enough github actions requires the distributed bundle to be in-tree, when commiting changes ensure that the bundle you have built is up-to-date with any changes made to the source.
65
+
Oddly enough GitHub actions requires the distributed bundle to be in-tree, when commiting changes ensure that the bundle you have built is up-to-date with any changes made to the source.
0 commit comments