Skip to content

Commit 1d859c5

Browse files
authored
build: Migrate from Makefile to justfile (#493)
## 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 - Update docs/*.md with just commands
2 parents 62220a0 + 6c2aadf commit 1d859c5

8 files changed

Lines changed: 359 additions & 279 deletions

File tree

.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: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ uv run pytest tests/test_cli.py::test_sync
4242
# Watch mode for tests (auto re-run on file changes)
4343
uv run ptw .
4444
# or
45-
make start
45+
just start
4646

4747
# Run tests with coverage
4848
uv run py.test --cov -v
@@ -54,31 +54,31 @@ uv run py.test --cov -v
5454
# Format code with ruff
5555
uv run ruff format .
5656
# or
57-
make ruff_format
57+
just ruff-format
5858

5959
# Run ruff linting with auto-fixes
6060
uv run ruff check . --fix --show-fixes
6161
# or
62-
make ruff
62+
just ruff
6363

6464
# Run mypy type checking
6565
uv run mypy
6666
# or
67-
make mypy
67+
just mypy
6868

6969
# Watch mode for linting (using entr)
70-
make watch_ruff
71-
make watch_mypy
70+
just watch-ruff
71+
just watch-mypy
7272
```
7373

7474
#### Documentation
7575

7676
```bash
7777
# Build documentation
78-
make build_docs
78+
just build-docs
7979

8080
# Start documentation server (auto-reload)
81-
make start_docs
81+
just start-docs
8282
```
8383

8484
## Development Process

CHANGES

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,13 @@ $ uvx --from 'vcspull' --prerelease allow vcspull
3131

3232
<!-- Maintainers, insert changes / features for the next release here -->
3333

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

3643
- Migrate docs deployment to AWS OIDC authentication and AWS CLI

Makefile

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

docs/Makefile

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

0 commit comments

Comments
 (0)