From cb60ca6b4fc8b1fbc11b97d199dbc76cb26deef1 Mon Sep 17 00:00:00 2001 From: Feist Josselin Date: Mon, 20 May 2024 12:46:37 +0200 Subject: [PATCH 1/4] Add medusa docs --- .github/workflows/deploy.yml | 1 + .gitmodules | 3 +++ SUMMARY.md | 10 ++++++++++ program-analysis/medusa | 1 + 4 files changed, 15 insertions(+) create mode 100644 .gitmodules create mode 160000 program-analysis/medusa diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index d665f9a1..8439154c 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -22,6 +22,7 @@ jobs: - uses: actions/checkout@v4 with: fetch-depth: 0 + submodules: true - name: Install mdbook run: | cargo install --git https://github.com/montyly/mdBook.git mdbook || true diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..dc6ee18d --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "program-analysis/medusa"] + path = program-analysis/medusa + url = https://github.com/crytic/medusa.git diff --git a/SUMMARY.md b/SUMMARY.md index 67a6edd3..51eb37fd 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -106,6 +106,16 @@ - [Exercise 6](./program-analysis/echidna/exercises/Exercise-6.md) - [Exercise 7](./program-analysis/echidna/exercises/Exercise-7.md) - [Exercise 8](./program-analysis/echidna/exercises/Exercise-8.md) + - [Medusa](./program-analysis/medusa/docs/src/README.md) + - [Getting Started](./program-analysis/medusa/docs/src/getting_started/installation.md) + - [Project Configuration](./program-analysis/medusa/docs/src/project_configuration/overview.md) + the vast number of configuration options that can be set up based on your project needs. + - [Command Line Interface](./program-analysis/medusa/docs/src/cli/overview.md) + - [Writing Tests](./program-analysis/medusa/docs/src/testing/overview.md) + - [API (WIP)](./program-analysis/medusa/docs/src/api/api_overview.md) + - [Cheatcodes](./program-analysis/medusa/docs/src/cheatcodes/cheatcodes_overview.md) + - [Console Logging](./program-analysis/medusa/docs/src/console_logging.md) + - [FAQ](./program-analysis/medusa/docs/src/faq.md) - [Manticore](./program-analysis/manticore/README.md) - [Introduction to symbolic execution](./program-analysis/manticore/symbolic-execution-introduction.md): - [Running under Manticore](./program-analysis/manticore/running-under-manticore.md) diff --git a/program-analysis/medusa b/program-analysis/medusa new file mode 160000 index 00000000..67500325 --- /dev/null +++ b/program-analysis/medusa @@ -0,0 +1 @@ +Subproject commit 6750032502ed64952435dc408be3d8a1a107eb5c From 9fce63d5a5a9d19f792d68650985f59ecac1f236 Mon Sep 17 00:00:00 2001 From: Feist Josselin Date: Mon, 20 May 2024 12:53:28 +0200 Subject: [PATCH 2/4] fix space --- SUMMARY.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/SUMMARY.md b/SUMMARY.md index 51eb37fd..37cb46a0 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -106,16 +106,15 @@ - [Exercise 6](./program-analysis/echidna/exercises/Exercise-6.md) - [Exercise 7](./program-analysis/echidna/exercises/Exercise-7.md) - [Exercise 8](./program-analysis/echidna/exercises/Exercise-8.md) - - [Medusa](./program-analysis/medusa/docs/src/README.md) - - [Getting Started](./program-analysis/medusa/docs/src/getting_started/installation.md) - - [Project Configuration](./program-analysis/medusa/docs/src/project_configuration/overview.md) - the vast number of configuration options that can be set up based on your project needs. - - [Command Line Interface](./program-analysis/medusa/docs/src/cli/overview.md) - - [Writing Tests](./program-analysis/medusa/docs/src/testing/overview.md) - - [API (WIP)](./program-analysis/medusa/docs/src/api/api_overview.md) - - [Cheatcodes](./program-analysis/medusa/docs/src/cheatcodes/cheatcodes_overview.md) - - [Console Logging](./program-analysis/medusa/docs/src/console_logging.md) - - [FAQ](./program-analysis/medusa/docs/src/faq.md) + - [Medusa](./program-analysis/medusa/docs/src/README.md) - [Getting Started](./program-analysis/medusa/docs/src/getting_started/installation.md) + - [Project Configuration](./program-analysis/medusa/docs/src/project_configuration/overview.md) + the vast number of configuration options that can be set up based on your project needs. + - [Command Line Interface](./program-analysis/medusa/docs/src/cli/overview.md) + - [Writing Tests](./program-analysis/medusa/docs/src/testing/overview.md) + - [API (WIP)](./program-analysis/medusa/docs/src/api/api_overview.md) + - [Cheatcodes](./program-analysis/medusa/docs/src/cheatcodes/cheatcodes_overview.md) + - [Console Logging](./program-analysis/medusa/docs/src/console_logging.md) + - [FAQ](./program-analysis/medusa/docs/src/faq.md) - [Manticore](./program-analysis/manticore/README.md) - [Introduction to symbolic execution](./program-analysis/manticore/symbolic-execution-introduction.md): - [Running under Manticore](./program-analysis/manticore/running-under-manticore.md) From 9709bbe1d167a4f5bc1637692f5466aa2585b099 Mon Sep 17 00:00:00 2001 From: Feist Josselin Date: Mon, 20 May 2024 14:49:21 +0200 Subject: [PATCH 3/4] CI --- .github/workflows/lint_format.yml | 2 ++ .github/workflows/lint_links.yml | 1 + 2 files changed, 3 insertions(+) diff --git a/.github/workflows/lint_format.yml b/.github/workflows/lint_format.yml index 7b9dbf4d..4594b868 100644 --- a/.github/workflows/lint_format.yml +++ b/.github/workflows/lint_format.yml @@ -13,6 +13,8 @@ jobs: steps: - name: Checkout repository uses: actions/checkout@v4 + with: + submodules: true - name: Set up Node.js uses: actions/setup-node@v3 diff --git a/.github/workflows/lint_links.yml b/.github/workflows/lint_links.yml index a97a9615..61f57e8c 100644 --- a/.github/workflows/lint_links.yml +++ b/.github/workflows/lint_links.yml @@ -24,3 +24,4 @@ jobs: with: use-quiet-mode: "yes" check-modified-files-only: ${{ (github.event_name == 'pull_request' && 'yes') || 'no' }} + submodules: true From b00dc7e400c9ea86a4c55b03ecb2e7f0877523b7 Mon Sep 17 00:00:00 2001 From: Feist Josselin Date: Mon, 20 May 2024 18:54:09 +0200 Subject: [PATCH 4/4] minor --- .github/workflows/lint_format.yml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.github/workflows/lint_format.yml b/.github/workflows/lint_format.yml index 4594b868..c3d6605a 100644 --- a/.github/workflows/lint_format.yml +++ b/.github/workflows/lint_format.yml @@ -25,6 +25,13 @@ jobs: run: | npm ci + - name: Remove Medusa uncessary files + run: | + rm -rf program-analysis/medusa/chain + rm -rf program-analysis/medusa/compilation + rm -rf program-analysis/medusa/fuzzing + rm program-analysis/medusa/docs/theme/highlight.js + - name: Run lint run: | npm run lint:format