Skip to content

Replace Makefiles with justfiles for improved task automation #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
JoeyBF wants to merge 1 commit into from
Closed

Replace Makefiles with justfiles for improved task automation #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 49 additions & 23 deletions .github/workflows/ext.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ jobs:
- uses: actions/setup-python@v5
with:
python-version: "3.9"
- uses: extractions/setup-just@v2
with:
just-version: "1.34"

- name: Install rustup
id: rustup
Expand All @@ -40,16 +43,16 @@ jobs:
run: pip install pytest

- name: Run ext tests
run: make -C ext test
run: just --working-directory ext --justfile ext/justfile test

- name: Run ext examples
run: make -C ext benchmarks
run: just --working-directory ext --justfile ext/justfile benchmarks

- name: Run ext examples (nassau)
run: make -C ext benchmarks-nassau
run: just --working-directory ext --justfile ext/justfile benchmarks-nassau

- name: Run ext examples (concurrent)
run: make -C ext benchmarks-concurrent
run: just --working-directory ext --justfile ext/justfile benchmarks-concurrent

- name: Benchmark executable size
run: |
Expand All @@ -65,6 +68,9 @@ jobs:

steps:
- uses: actions/checkout@v4
- uses: extractions/setup-just@v2
with:
just-version: "1.34"

- name: Install rustup
id: rustup
Expand All @@ -83,7 +89,7 @@ jobs:
key: miri-${{ steps.rustup.outputs.rustc_hash }}-${{ hashFiles('**/Cargo.*') }}

- name: Run miri
run: make -C ext miri
run: just --working-directory ext --justfile ext/justfile miri

lint:
if: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository }}
Expand All @@ -95,6 +101,9 @@ jobs:

steps:
- uses: actions/checkout@v4
- uses: extractions/setup-just@v2
with:
just-version: "1.34"

- name: Install rustup
id: rustup
Expand All @@ -116,13 +125,13 @@ jobs:
key: lint-${{ steps.rustup.outputs.rustc_hash }}-${{ hashFiles('**/Cargo.*') }}

- name: Run lint
run: make -C ext lint
run: just --working-directory ext --justfile ext/justfile lint

- name: Lint sseq_gui
run: make -C web_ext/sseq_gui lint
run: just --working-directory web_ext/sseq_gui --justfile web_ext/sseq_gui/justfile lint

- name: Lint sseq_gui tests
run: make -C web_ext/sseq_gui lint-selenium
run: just --working-directory web_ext/sseq_gui --justfile web_ext/sseq_gui/justfile lint-selenium

# Build the wasm webserver with the default `panic=abort` configuration on
# stable/beta. This is the compatibility build; the deployed artifact is
Expand All @@ -143,6 +152,10 @@ jobs:
steps:
- uses: actions/checkout@v4

- uses: extractions/setup-just@v2
with:
just-version: "1.34"

- name: Install rustup
uses: dtolnay/rust-toolchain@v1
id: rustup
Expand All @@ -164,16 +177,16 @@ jobs:
run: sudo apt-get install binaryen

- name: Setup build environment
run: make -C web_ext/sseq_gui setup-wasm
run: just --working-directory web_ext/sseq_gui --justfile web_ext/sseq_gui/justfile setup-wasm

- name: Lint sseq_gui wasm
run: make -C web_ext/sseq_gui lint-wasm
run: just --working-directory web_ext/sseq_gui --justfile web_ext/sseq_gui/justfile lint-wasm

- name: Test worker panic handling
run: make -C web_ext/sseq_gui test-wasm-js
run: just --working-directory web_ext/sseq_gui --justfile web_ext/sseq_gui/justfile test-wasm-js

- name: Build wasm
run: make -C web_ext/sseq_gui wasm
run: just --working-directory web_ext/sseq_gui --justfile web_ext/sseq_gui/justfile wasm

- name: Benchmark wasm size
run: ls -l web_ext/sseq_gui/dist/sseq_gui_wasm_bg.wasm
Expand All @@ -198,6 +211,10 @@ jobs:
steps:
- uses: actions/checkout@v4

- uses: extractions/setup-just@v2
with:
just-version: "1.34"

- name: Install rustup
uses: dtolnay/rust-toolchain@v1
id: rustup
Expand All @@ -220,13 +237,13 @@ jobs:
run: sudo apt-get install -y binaryen wabt

- name: Setup build environment
run: make -C web_ext/sseq_gui setup-wasm
run: just --working-directory web_ext/sseq_gui --justfile web_ext/sseq_gui/justfile setup-wasm

- name: Build wasm (panic=unwind)
run: make -C web_ext/sseq_gui wasm WASM_UNWIND=1
run: just --working-directory web_ext/sseq_gui --justfile web_ext/sseq_gui/justfile WASM_UNWIND=1 wasm

- name: Verify wasm unwinding
run: make -C web_ext/sseq_gui test-wasm-unwind
run: just --working-directory web_ext/sseq_gui --justfile web_ext/sseq_gui/justfile test-wasm-unwind

- name: Benchmark wasm size
run: ls -l web_ext/sseq_gui/dist/sseq_gui_wasm_bg.wasm
Expand Down Expand Up @@ -259,6 +276,9 @@ jobs:
continue-on-error: ${{ matrix.toolchain != 'stable' }}
steps:
- uses: actions/checkout@v4
- uses: extractions/setup-just@v2
with:
just-version: "1.34"

- name: Download webserver
uses: actions/download-artifact@v4
Expand Down Expand Up @@ -295,20 +315,20 @@ jobs:

- name: Test wasm
run: |
make serve-wasm &
(sleep 1 && xvfb-run -a -s "-screen 0 1280x720x24" make selenium)
just serve-wasm &
(sleep 1 && xvfb-run -a -s "-screen 0 1280x720x24" just selenium)

- name: Test local
run: |
cargo build &&
(target/debug/sseq_gui &
(sleep 1 && xvfb-run -a -s "-screen 0 1280x720x24" make selenium))
(sleep 1 && xvfb-run -a -s "-screen 0 1280x720x24" just selenium))

- name: Test local concurrent
run: |
cargo build --features concurrent &&
(target/debug/sseq_gui &
(sleep 1 && xvfb-run -a -s "-screen 0 1280x720x24" make selenium))
(sleep 1 && xvfb-run -a -s "-screen 0 1280x720x24" just selenium))

- name: Upload Artifact
if: ${{ failure() }}
Expand All @@ -332,6 +352,9 @@ jobs:
continue-on-error: ${{ matrix.toolchain != 'stable' }}
steps:
- uses: actions/checkout@v4
- uses: extractions/setup-just@v2
with:
just-version: "1.34"

- name: Install rustup
id: rustup
Expand All @@ -354,13 +377,13 @@ jobs:
run: sudo apt-get install binaryen

- name: Setup build environment
run: make -C web_ext/steenrod_calculator setup-wasm
run: just --working-directory web_ext/steenrod_calculator --justfile web_ext/steenrod_calculator/justfile setup-wasm

- name: Lint sseq_gui wasm
run: make -C web_ext/steenrod_calculator lint
run: just --working-directory web_ext/steenrod_calculator --justfile web_ext/steenrod_calculator/justfile lint

- name: Build wasm
run: make -C web_ext/steenrod_calculator
run: just --working-directory web_ext/steenrod_calculator --justfile web_ext/steenrod_calculator/justfile all

- name: Benchmark wasm size
run: ls -l web_ext/steenrod_calculator/dist/steenrod_calculator_wasm_bg.wasm
Expand All @@ -387,6 +410,9 @@ jobs:
continue-on-error: ${{ matrix.toolchain != 'stable' }}
steps:
- uses: actions/checkout@v4
- uses: extractions/setup-just@v2
with:
just-version: "1.34"

- name: Install rustup
id: rustup
Expand All @@ -405,7 +431,7 @@ jobs:
key: docs-${{ steps.rustup.outputs.rustc_hash }}-${{ hashFiles('ext/Cargo.*') }}

- name: Generate docs
run: make -C ext docs
run: just --working-directory ext --justfile ext/justfile docs

- name: Upload docs
uses: actions/upload-artifact@v4
Expand Down
81 changes: 0 additions & 81 deletions ext/Makefile
View file
Open in desktop

This file was deleted.

18 changes: 9 additions & 9 deletions ext/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Documentation for both the examples and the library itself is hosted at
If documentation for a specific version of the library is sought, it can be generated by running

```shell
make docs
just docs
```

after which the documentation is placed at `target/doc/`. The link above opens
Expand All @@ -94,7 +94,7 @@ the file `target/doc/ext/index.html`.
Lint scripts can be run with

```shell
make lint
just lint
```

This runs `clippy` and `rustfmt`.
Expand All @@ -108,7 +108,7 @@ There are multiple types of tests
These can be run by

```shell
make test
just test
```

#### Example benchmarks
Expand All @@ -121,14 +121,14 @@ the output should be.
These can be run by

```shell
make benchmarks
make benchmarks-concurrent
just benchmarks
just benchmarks-concurrent
```

Running

```shell
make fix-benchmarks
just fix-benchmarks
```

updates the outputs in all benchmark files to match the current program output.
Expand All @@ -137,7 +137,7 @@ This is useful for adding new benchmarks.
These can be run for individual benchmarks by e.g.

```shell
make examples/benchmarks/resolve-S_2
make examples/benchmarks/resolve-S_2-concurrent
make examples/benchmarks/resolve-S_2-fixed
just bench resolve-S_2
just bench-concurrent resolve-S_2
just fix-bench resolve-S_2
```
12 changes: 6 additions & 6 deletions ext/flake.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@
export RUSTFLAGS="-D warnings"
export RUSTDOCFLAGS="-D warnings"

make lint
make test
make benchmarks
make benchmarks-nassau
make benchmarks-concurrent
make miri
just lint
just test
just benchmarks
just benchmarks-nassau
just benchmarks-concurrent
just miri
'');
};
});
Expand Down
Loading
Loading