Skip to content

Commit 64e3d0a

Browse files
committed
Add comments to all make targets
1 parent ddd542b commit 64e3d0a

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

Makefile

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,29 @@
22

33
### Bash
44

5+
# Remove installed files from system
56
clean:
67
rm /usr/local/bin/map
78
rm /usr/local/bin/filter
89
rm -rf /usr/local/lib/fs
910

11+
# Run bash CI pipeline: lint and test
1012
ci-bash: lint test
1113

14+
# Alias for format target
1215
fmt: format
1316

17+
# Auto-format code using shellcheck diff output
1418
format:
1519
shellcheck -x -f diff fs/operations/* | git apply --allow-empty
1620
shellcheck -x -f diff
1721
shellcheck -x -f diff filter | git apply --allow-empty
1822

23+
# Run installation script
1924
install:
2025
./install.sh
2126

27+
# Run shellcheck on all shell scripts
2228
lint:
2329
shellcheck -x -e SC1091 map
2430
shellcheck -x -e SC1091 filter
@@ -28,38 +34,48 @@ lint:
2834
shellcheck -x update-sha256.sh
2935
shellcheck -x it-test-setup.sh
3036

37+
# Setup development environment with required tools
3138
setup:
3239
@echo "Setting up the environment..."
3340
@brew install shellcheck bats parallel
3441

42+
# Run all Bats tests
3543
test:
3644
bats -j 15 tests/
3745

46+
# Update SHA256 checksums
3847
update-sha256:
3948
./update-sha256.sh
4049

4150

4251
### Python
4352

53+
# Run Python CI pipeline: install deps, install locally, run integration tests
4454
ci-py: install-py-deps local-install-ci it-test
4555

56+
# Setup Python environment with specific version
4657
setup-py:
4758
poetry env use python3.11
4859

60+
# Install Python dependencies for testing
4961
install-py-deps:
5062
poetry install --only=test
5163

64+
# Run integration tests with automatic setup and cleanup
5265
it-test: it-test-install
5366
poetry run pytest -s tests/integration-tests/tests.py
5467
./it-test-setup.sh uninstall
5568

69+
# Install files to system paths with sudo (for CI)
5670
local-install-ci:
5771
sudo cp -f ./map /usr/local/bin/
5872
sudo cp -f ./filter /usr/local/bin/
5973
sudo cp -rf ./fs /usr/local/lib/
6074

75+
# Install symlinks for integration testing
6176
it-test-install:
6277
./it-test-setup.sh install
6378

79+
# Remove symlinks created for integration testing
6480
it-test-uninstall:
6581
./it-test-setup.sh uninstall

0 commit comments

Comments
 (0)