Skip to content

Commit d6d544e

Browse files
authored
build: Migrate from Makefile to justfile (#617)
## Summary - Replace Makefile with justfile for task running - Update documentation to reference just commands ## Changes - Add root justfile with all project tasks - Add docs/justfile for documentation tasks - Remove Makefile and docs/Makefile - Update AGENTS.md/CLAUDE.md with just commands
2 parents c59e996 + 031ea96 commit d6d544e

File tree

7 files changed

+355
-262
lines changed

7 files changed

+355
-262
lines changed

.github/workflows/docs.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ jobs:
5353
if: env.PUBLISH == 'true'
5454
run: uv sync --all-extras --dev
5555

56+
- name: Install just
57+
if: env.PUBLISH == 'true'
58+
uses: extractions/setup-just@v2
59+
5660
- name: Print python versions
5761
if: env.PUBLISH == 'true'
5862
run: |
@@ -62,7 +66,7 @@ jobs:
6266
- name: Build documentation
6367
if: env.PUBLISH == 'true'
6468
run: |
65-
pushd docs; make SPHINXBUILD='uv run sphinx-build' html; popd
69+
cd docs && just html
6670
6771
- name: Configure AWS Credentials
6872
if: env.PUBLISH == 'true'

AGENTS.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ uv pip install --editable . -G dev
4949

5050
```bash
5151
# Run all tests
52-
make test
52+
just test
5353
# or directly with pytest
5454
uv run pytest
5555

@@ -60,7 +60,7 @@ uv run pytest tests/test_pane.py
6060
uv run pytest tests/test_pane.py::test_send_keys
6161

6262
# Run tests with test watcher
63-
make start
63+
just start
6464
# or
6565
uv run ptw .
6666

@@ -72,26 +72,26 @@ uv run ptw . --now --doctest-modules
7272

7373
```bash
7474
# Run ruff for linting
75-
make ruff
75+
just ruff
7676
# or directly
7777
uv run ruff check .
7878

7979
# Format code with ruff
80-
make ruff_format
80+
just ruff-format
8181
# or directly
8282
uv run ruff format .
8383

8484
# Run ruff linting with auto-fixes
8585
uv run ruff check . --fix --show-fixes
8686

8787
# Run mypy for type checking
88-
make mypy
88+
just mypy
8989
# or directly
9090
uv run mypy src tests
9191

9292
# Watch mode for linting (using entr)
93-
make watch_ruff
94-
make watch_mypy
93+
just watch-ruff
94+
just watch-mypy
9595
```
9696

9797
### Development Workflow
@@ -108,13 +108,13 @@ Follow this workflow for code changes:
108108

109109
```bash
110110
# Build documentation
111-
make build_docs
111+
just build-docs
112112

113113
# Start documentation server with auto-reload
114-
make start_docs
114+
just start-docs
115115

116116
# Update documentation CSS/JS
117-
make design_docs
117+
just design-docs
118118
```
119119

120120
## Code Architecture

CHANGES

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@ $ uvx --from 'libtmux' --prerelease allow python
3232

3333
<!-- To maintainers and contributors: Please add notes for the forthcoming version below -->
3434

35+
### Development
36+
37+
#### Makefile -> Justfile (#617)
38+
39+
- Migrate from `Makefile` to `justfile` for running development tasks
40+
- Update documentation to reference `just` commands
41+
3542
### Documentation
3643

3744
Move documentation deployment to GitHub OIDC and AWS CLI.

Makefile

Lines changed: 0 additions & 63 deletions
This file was deleted.

docs/Makefile

Lines changed: 0 additions & 188 deletions
This file was deleted.

0 commit comments

Comments
 (0)