Skip to content

Commit

Permalink
Update action dependencies and relicense
Browse files Browse the repository at this point in the history
  • Loading branch information
emesare committed Jan 14, 2025
1 parent ac00ecf commit 52b4448
Show file tree
Hide file tree
Showing 9 changed files with 37,636 additions and 18,523 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
node_modules
node_modules
deno.lock
.idea
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Mason Reed
Copyright (c) 2025 Vector 35

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Setup Binary Ninja action

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`.
This action installs [Binary Ninja] for testing and building both native and python plugins within GitHub CI.

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`.

## Example usage

When using this action it should be noted that the license input should basically always be a secret.

```yaml
uses: emesare/setup-binary-ninja@v1-beta
uses: Vector35/setup-binary-ninja@v1
with:
license: '${{ secrets.BN_SERIAL }}'
```
Expand All @@ -32,11 +34,11 @@ Override the default download process. This is for advanced use cases where you

### `dev-branch`

Whether or not to use the developer branch of [Binary Ninja]. Default is `false`.
Whether to use the development branch of [Binary Ninja]. Default is `false`.

### `python-support`

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`.
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`.

## Outputs

Expand All @@ -48,7 +50,7 @@ The installation directory.

### Building

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`.
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`.

### Testing

Expand All @@ -60,7 +62,7 @@ act push -s BN_SERIAL=yourserial -P ubuntu-latest=catthehacker/ubuntu:act-latest

### Commiting

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.
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.

[Binary Ninja]: https://binary.ninja
[act]: https://github.com/nektos/act
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: 'Setup Binary Ninja environment'
description: 'Setup Binary Ninja within your github actions runner'
author: 'emesare'
author: 'Vector35'
branding:
icon: 'bold'
color: 'red'
Expand All @@ -22,5 +22,5 @@ outputs:
install-path:
description: "Where Binary Ninja was installed"
runs:
using: "node16"
using: "node20"
main: "dist/index.js"
Loading

0 comments on commit 52b4448

Please sign in to comment.