From fd7a99bf454085443c961aa94b0235845da64573 Mon Sep 17 00:00:00 2001 From: Gavin Gray <20209337+gavinleroy@users.noreply.github.com> Date: Thu, 9 Jan 2025 08:47:43 -0500 Subject: [PATCH] v0.3.5 (#149) * Bump version and move local playground instructions to CONTRIBUTING * Fix syntax error in action * Fix syntax error in action --- .github/workflows/standalone.yml | 30 ++--- CONTRIBUTING.md | 4 + Makefile.toml | 13 +- README.md | 125 -------------------- crates/aquascope_workspace_utils/Cargo.toml | 4 +- crates/mdbook-aquascope/Cargo.toml | 2 +- 6 files changed, 24 insertions(+), 154 deletions(-) diff --git a/.github/workflows/standalone.yml b/.github/workflows/standalone.yml index 7c88dc629..66dac2553 100644 --- a/.github/workflows/standalone.yml +++ b/.github/workflows/standalone.yml @@ -5,23 +5,25 @@ on: branches: [standalone-wasm] types: [labeled,closed] - jobs: +jobs: update-frontend: needs: publish-crates runs-on: ubuntu-latest - if: false # disable for now steps: - - uses: actions/checkout@v3 - - uses: DeterminateSystems/nix-installer-action@main - - uses: DeterminateSystems/magic-nix-cache-action@main - - uses: DeterminateSystems/flake-checker-action@main + - name: Skipping action + run: echo "TODO--bring back frontend tests" - - name: Build Docs and Standalone - run: nix develop .#minimal --command ci-build-pages + # - uses: actions/checkout@v3 + # - uses: DeterminateSystems/nix-installer-action@main + # - uses: DeterminateSystems/magic-nix-cache-action@main + # - uses: DeterminateSystems/flake-checker-action@main - - uses: JamesIves/github-pages-deploy-action@v4.3.0 - with: - branch: gh-pages - folder: ./frontend/packages/aquascope-standalone/dist - clean: true - clean-exclude: dev + # - name: Build Docs and Standalone + # run: nix develop .#minimal --command ci-build-pages + + # - uses: JamesIves/github-pages-deploy-action@v4.3.0 + # with: + # branch: gh-pages + # folder: ./frontend/packages/aquascope-standalone/dist + # clean: true + # clean-exclude: dev diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1837198a..0c294b7a6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,10 @@ End-to-end testing is done with snapshot testing via [insta](https://github.com/ ### Debugging +We use the local playground to debug Aquascope. In one terminal, run `cargo run`, to run the local server. In a separate terminal, navigate to the `frontend` directory and run `depot --no-fullscreen build --watch`. The playground is live at `localhost:5173`, the server will log debug information about the programs you analyze. + +> Note, the local playground **does not** run within a sandbox. + To see the full permissions analysis and get all debug output start a server with `cargo make watch`. Then, start an instance of the frontend by running `depot build -w` from the `frontend` directory. The page is served on `localhost:5173`. ## Asking questions diff --git a/Makefile.toml b/Makefile.toml index 1a11bc911..46d56bf22 100644 --- a/Makefile.toml +++ b/Makefile.toml @@ -12,7 +12,7 @@ script = "cargo watch -i frontend -x 'install --path crates/aquascope_front --of script = "cargo watch -w crates/mdbook-aquascope/src -w frontend/packages/aquascope-embed/dist --no-vcs-ignores -x 'install --path crates/mdbook-aquascope --debug --offline'" [tasks.watch-server] -script = "cargo run --features=no-docker" +script = "cargo run" [tasks.watch.run_task] name = ["watch-front", "watch-server", "watch-mdbook"] @@ -37,14 +37,3 @@ cargo install --path crates/aquascope_front --locked [tasks.install-mdbook] dependencies = ["install-aquascope"] script = "cargo install --path crates/mdbook-aquascope --locked" - -[tasks.playground-front] -script = """ -export MIRI_SYSROOT=$(cargo miri setup --print-sysroot) -cd frontend && depot --no-fullscreen build --watch -""" - -[tasks.playground.run_task] -dependencies = ["install-aquascope"] -name = ["watch-server", "playground-front"] -parallel = true diff --git a/README.md b/README.md index 013f531a2..3ac8dc11a 100644 --- a/README.md +++ b/README.md @@ -67,131 +67,6 @@ Then add an Aquascope code block to one of your Markdown source files like this: Further documentation on the syntax and configuration of Aquascope blocks will be provided once the interface is more stable. -### Local Playground - -Running the provided [playground](https://cognitive-engineering-lab.github.io/aquascope/) locally is also easy. First, you'll need to follow the above *from source* installation instructions. Then, you can launch the server by running `cargo make playground` and navigate to [`localhost:5173`](http://localhost:5173/) to explore. - -> Note, the local playground **does not** run the tool within a sandbox. This makes the local version quicker, but don't run any malicious programs. - - - ## Having trouble? If you want to use Aquascope but are having trouble finding the relevant information, please leave an issue or email us at and . diff --git a/crates/aquascope_workspace_utils/Cargo.toml b/crates/aquascope_workspace_utils/Cargo.toml index 361794d67..1e03ddf4d 100644 --- a/crates/aquascope_workspace_utils/Cargo.toml +++ b/crates/aquascope_workspace_utils/Cargo.toml @@ -4,7 +4,7 @@ authors = [ "Will Crichton ", "Gavin Gray " ] -version = "0.3.4" +version = "0.3.5" license = "MIT" edition = "2021" description = "Handy utilities for working in the Aquascope workspace" @@ -20,4 +20,4 @@ include = [ [dependencies] toml = "0.5" anyhow = "1" -serde = { workspace = true } \ No newline at end of file +serde = { workspace = true } diff --git a/crates/mdbook-aquascope/Cargo.toml b/crates/mdbook-aquascope/Cargo.toml index dd5783faf..5db7b591a 100644 --- a/crates/mdbook-aquascope/Cargo.toml +++ b/crates/mdbook-aquascope/Cargo.toml @@ -6,7 +6,7 @@ authors = [ ] description = "Interactive Aquascope editor for your mdBook" license = "MIT" -version = "0.3.4" +version = "0.3.5" edition = "2021" include = [ "src/**/*",