Skip to content

Commit 2b703b6

Browse files
build: namespace make targets with / separator
Group related targets under a common namespace for discoverability: - docs -> docs/build - (new) -> docs/lint - (new) -> docs/format - test -> test/pyathena - test-sqla -> test/sqla - test-sqla-async-> test/sqla-async Propagate the rename through pyproject.toml (tox commands), CLAUDE.md, docs/testing.md, and the docs/docs-lint GitHub workflows. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 129854a commit 2b703b6

6 files changed

Lines changed: 27 additions & 24 deletions

File tree

.github/workflows/docs-lint.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
steps:
2020
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
2121
- uses: jdx/mise-action@1648a7812b9aeae629881980618f079932869151 # v4.0.1
22-
- run: make docs-lint
22+
- run: make docs/lint
2323

2424
build:
2525
runs-on: ubuntu-latest
@@ -33,4 +33,4 @@ jobs:
3333
enable-cache: true
3434
- run: |
3535
uv sync --group dev
36-
make docs
36+
make docs/build

.github/workflows/docs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
enable-cache: true
3333
- run: |
3434
uv sync --group dev
35-
make docs
35+
make docs/build
3636
- name: Upload artifact
3737
uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
3838
with:

CLAUDE.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ make lint # Lint + format check + mypy
2828

2929
```bash
3030
# ALWAYS run `make lint` first — tests will fail if lint doesn't pass
31-
make test # Unit tests (runs chk first)
32-
make test-sqla # SQLAlchemy dialect tests
31+
make test/pyathena # Unit tests (runs lint first)
32+
make test/sqla # SQLAlchemy dialect tests
33+
make test/sqla-async # SQLAlchemy async dialect tests
3334
```
3435

3536
Tests require AWS environment variables. Use a `.env` file (gitignored):
@@ -73,8 +74,9 @@ export $(cat .env | xargs) && uv run pytest tests/pyathena/test_file.py -v
7374

7475
```bash
7576
mise install # one-time: installs markdownlint-cli2
76-
make docs-lint # check
77-
make docs-lint-fix # auto-fix what's possible
77+
make docs/lint # check
78+
make docs/format # auto-fix what's possible
79+
make docs/build # build the Sphinx site under docs/_build/html
7880
```
7981

8082
## Architecture — Key Design Decisions

Makefile

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,35 +13,35 @@ lint:
1313
uvx ruff@$(RUFF_VERSION) format --check .
1414
uv run mypy .
1515

16-
.PHONY: test
17-
test: lint
16+
.PHONY: test/pyathena
17+
test/pyathena: lint
1818
uv run pytest -n 8 --cov pyathena --cov-report html --cov-report term tests/pyathena/
1919

20-
.PHONY: test-sqla
21-
test-sqla:
20+
.PHONY: test/sqla
21+
test/sqla:
2222
uv run pytest -n 8 --cov pyathena --cov-report html --cov-report term tests/sqlalchemy/
2323

24-
.PHONY: test-sqla-async
25-
test-sqla-async:
24+
.PHONY: test/sqla-async
25+
test/sqla-async:
2626
uv run pytest -n 8 --cov pyathena --cov-report html --cov-report term tests/sqlalchemy/ --dburi async
2727

2828
.PHONY: tox
2929
tox:
3030
uvx tox@$(TOX_VERSION) -c pyproject.toml run
3131

32-
.PHONY: docs
33-
docs:
32+
.PHONY: docs/build
33+
docs/build:
3434
uv run sphinx-multiversion docs docs/_build/html
3535
echo '<meta http-equiv="refresh" content="0; url=./master/index.html">' > docs/_build/html/index.html
3636
echo 'pyathena.dev' > docs/_build/html/CNAME
3737
touch docs/_build/html/.nojekyll
3838

39-
.PHONY: docs-lint
40-
docs-lint:
39+
.PHONY: docs/lint
40+
docs/lint:
4141
mise exec -- markdownlint-cli2
4242

43-
.PHONY: docs-lint-fix
44-
docs-lint-fix:
43+
.PHONY: docs/format
44+
docs/format:
4545
mise exec -- markdownlint-cli2 --fix
4646

4747
.PHONY: tool

docs/testing.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@ $ export AWS_ATHENA_MANAGED_WORKGROUP=pyathena-managed
3333

3434
```bash
3535
$ pip install uv or pipx install uv or brew install uv or mise install uv
36-
$ make test
37-
$ make test-sqla
36+
$ make test/pyathena
37+
$ make test/sqla
38+
$ make test/sqla-async
3839
```
3940

4041
## Run test multiple Python versions

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -226,9 +226,9 @@ allowlist_externals =
226226
make
227227
commands =
228228
uv sync --group dev
229-
pyathena: make test
230-
sqla: make test-sqla
231-
sqla_async: make test-sqla-async
229+
pyathena: make test/pyathena
230+
sqla: make test/sqla
231+
sqla_async: make test/sqla-async
232232
passenv =
233233
TOXENV
234234
AWS_*

0 commit comments

Comments
 (0)