Skip to content

Commit 90cb257

Browse files
authored
build: Migrate from Makefile to justfile (#500)
## 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 d36954d + b02d906 commit 90cb257

File tree

8 files changed

+359
-310
lines changed

8 files changed

+359
-310
lines changed

.github/workflows/docs.yml

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

55+
- name: Install just
56+
if: env.PUBLISH == 'true'
57+
uses: extractions/setup-just@v2
58+
5559
- name: Build documentation
5660
if: env.PUBLISH == 'true'
5761
run: |
58-
pushd docs; make SPHINXBUILD='uv run sphinx-build' html; popd
62+
cd docs && just html
5963
6064
- name: Configure AWS Credentials
6165
if: env.PUBLISH == 'true'

AGENTS.md

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

4848
```bash
4949
# Run all tests
50-
make test
50+
just test
5151
# or directly with pytest
5252
uv run pytest
5353

@@ -58,7 +58,7 @@ uv run pytest tests/sync/test_git.py
5858
uv run pytest tests/sync/test_git.py::test_remotes
5959

6060
# Run tests with test watcher
61-
make start
61+
just start
6262
# or
6363
uv run ptw .
6464
```
@@ -67,26 +67,26 @@ uv run ptw .
6767

6868
```bash
6969
# Run ruff for linting
70-
make ruff
70+
just ruff
7171
# or directly
7272
uv run ruff check .
7373

7474
# Format code with ruff
75-
make ruff_format
75+
just ruff-format
7676
# or directly
7777
uv run ruff format .
7878

7979
# Run ruff linting with auto-fixes
8080
uv run ruff check . --fix --show-fixes
8181

8282
# Run mypy for type checking
83-
make mypy
83+
just mypy
8484
# or directly
8585
uv run mypy src tests
8686

8787
# Watch mode for linting (using entr)
88-
make watch_ruff
89-
make watch_mypy
88+
just watch-ruff
89+
just watch-mypy
9090
```
9191

9292
### Development Workflow
@@ -103,13 +103,13 @@ Follow this workflow for code changes:
103103

104104
```bash
105105
# Build documentation
106-
make build_docs
106+
just build-docs
107107

108108
# Start documentation server with auto-reload
109-
make start_docs
109+
just start-docs
110110

111111
# Update documentation CSS/JS
112-
make design_docs
112+
just design-docs
113113
```
114114

115115
## Code Architecture

CHANGES

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@ $ uv add libvcs --prerelease allow
2020

2121
_Upcoming changes will be written here._
2222

23+
### Development
24+
25+
#### Makefile -> Justfile (#500)
26+
27+
- Migrate from `Makefile` to `justfile` for running development tasks
28+
- Update documentation to reference `just` commands
29+
2330
### Documentation
2431

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

Makefile

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

docs/Makefile

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

0 commit comments

Comments
 (0)