vacp2p
/
libp2p-test-plans
mirror of https://github.com/vacp2p/libp2p-test-plans.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore(perf): document GitHub action usage (#212)

This commit is contained in:
Max Inden 2023-06-30 04:25:05 +02:00 committed by GitHub
parent 7c43c940ce
commit 0df7762587
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
perf/README.md
View File

@ -8,9 +8,16 @@ This project includes the following components:
Benchmark results can be visualized with https://observablehq.com/@mxinden-workspace/libp2p-performance-dashboard.
## Provision infrastructure
## Running via GitHub Action
### Bootstrap
1. Create a pull request with your changes on https://github.com/libp2p/test-plans/.
2. Trigger GitHub Action for branch on https://github.com/libp2p/test-plans/actions/workflows/perf.yml (see _Run workflow_ button).
3. Wait for action run to finish and to push a commit to your branch.
4. Visualize results on https://observablehq.com/@libp2p-workspace/performance-dashboard.
## Running via local machine
### Provision infrastructure
1. Save your public SSH key as the file `./terraform/modules/short_lived/files/perf.pub`; or generate a new key pair with `make ssh-keygen` and add it to your SSH agent with `make ssh-add`.
2. `cd terraform/configs/local`
@ -19,7 +26,7 @@ Benchmark results can be visualized with https://observablehq.com/@mxinden-works
5. `CLIENT_IP=$(terraform output -raw client_ip)`
6. `SERVER_IP=$(terraform output -raw server_ip)`
## Build and run implementations
### Build and run implementations
_WARNING_: Running the perf tests might take a while.
@ -27,7 +34,7 @@ _WARNING_: Running the perf tests might take a while.
2. `npm ci`
3. `npm run start -- --client-public-ip $CLIENT_IP --server-public-ip $SERVER_IP`
## Deprovision infrastructure
### Deprovision infrastructure
1. `cd terraform/configs/local`
2. `terraform destroy`