-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathjustfile
More file actions
992 lines (855 loc) · 32.3 KB
/
justfile
File metadata and controls
992 lines (855 loc) · 32.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# List all recipes
default:
@just --list
# Contents
## CI/CD
## Conda
## Containers
## Docs
## Nix
## Python
## Release
## Rust
## Secrets
## Template
## CI/CD
# Build a category of nix flake outputs for CI matrix
[group('CI/CD')]
ci-build-category system category:
bash scripts/ci/ci-build-category.sh {{system}} {{category}}
# Scan repository for hardcoded secrets
[group('CI/CD')]
scan-secrets:
gitleaks detect --verbose --redact
# Scan staged files for hardcoded secrets (pre-commit)
[group('CI/CD')]
scan-staged:
gitleaks protect --staged --verbose --redact
# Set gcloud context
[group('CI/CD')]
gcloud-context:
gcloud config configurations activate "$GCP_PROJECT_NAME"
# Update github vars for repo from environment variables
[group('CI/CD')]
ghvars repo="sciexp/python-nix-template":
@echo "vars before updates:"
@echo
PAGER=cat gh variable list --repo={{ repo }}
@echo
gh variable set CACHIX_CACHE_NAME --repo={{ repo }} --body="$CACHIX_CACHE_NAME"
gh variable set FAST_FORWARD_ACTOR --repo={{ repo }} --body="$FAST_FORWARD_ACTOR"
@echo
@echo "vars after updates (wait 3 seconds for github to update):"
sleep 3
@echo
PAGER=cat gh variable list --repo={{ repo }}
# Update github secrets for repo from environment variables
[group('CI/CD')]
ghsecrets repo="sciexp/python-nix-template":
@echo "secrets before updates:"
@echo
PAGER=cat gh secret list --repo={{ repo }}
@echo
sops exec-env vars/shared.yaml '\
gh secret set CACHIX_AUTH_TOKEN --repo={{ repo }} --body="$CACHIX_AUTH_TOKEN" && \
gh secret set CODECOV_TOKEN --repo={{ repo }} --body="$CODECOV_TOKEN" && \
gh secret set FAST_FORWARD_PAT --repo={{ repo }} --body="$FAST_FORWARD_PAT" && \
gh secret set GITGUARDIAN_API_KEY --repo={{ repo }} --body="$GITGUARDIAN_API_KEY" && \
gh secret set UV_PUBLISH_TOKEN --repo={{ repo }} --body="$UV_PUBLISH_TOKEN" && \
gh secret set CLOUDFLARE_ACCOUNT_ID --repo={{ repo }} --body="$CLOUDFLARE_ACCOUNT_ID" && \
gh secret set CLOUDFLARE_API_TOKEN --repo={{ repo }} --body="$CLOUDFLARE_API_TOKEN" && \
gh secret set FLAKE_UPDATER_APP_ID --repo={{ repo }} --body="$FLAKE_UPDATER_APP_ID" && \
gh secret set FLAKE_UPDATER_PRIVATE_KEY --repo={{ repo }} --body="$FLAKE_UPDATER_PRIVATE_KEY"'
@echo
@echo "secrets after updates (wait 3 seconds for github to update):"
sleep 3
@echo
PAGER=cat gh secret list --repo={{ repo }}
# Run pre-commit hooks (see pre-commit.nix and note the yaml is git-ignored)
[group('CI/CD')]
pre-commit:
pre-commit run --all-files
# List available workflows and associated jobs using act
[group('CI/CD')]
list-workflows:
@act -l
# Test build-docs job locally with act
[group('CI/CD')]
test-docs-build branch=`git branch --show-current`:
@echo "Testing docs build job locally (branch: {{branch}})..."
@sops exec-env vars/shared.yaml 'act workflow_dispatch \
-W .github/workflows/deploy-docs.yaml \
-j build-docs \
-s CI_AGE_KEY -s CACHIX_AUTH_TOKEN \
-s GITHUB_TOKEN="$(gh auth token)" \
--var CACHIX_CACHE_NAME \
--input debug_enabled=false \
--input branch={{branch}}'
# Test full deploy-docs workflow locally with act
[group('CI/CD')]
test-docs-deploy branch=`git branch --show-current`:
@echo "Testing full docs deployment workflow locally (branch: {{branch}})..."
@echo "Note: Cloudflare deployment may not work in local environment"
@sops exec-env vars/shared.yaml 'act workflow_dispatch \
-W .github/workflows/deploy-docs.yaml \
-s CI_AGE_KEY -s CACHIX_AUTH_TOKEN \
-s CLOUDFLARE_API_TOKEN -s CLOUDFLARE_ACCOUNT_ID \
-s GITHUB_TOKEN="$(gh auth token)" \
--var CACHIX_CACHE_NAME \
--input debug_enabled=false \
--input branch={{branch}}'
# Trigger docs build job remotely on GitHub (requires workflow on main)
[group('CI/CD')]
gh-docs-build branch=`git branch --show-current` debug="false":
#!/usr/bin/env bash
echo "Triggering docs build workflow on GitHub (branch: {{branch}}, debug: {{debug}})..."
echo "Note: This requires deploy-docs.yaml to exist on the default branch"
gh workflow run deploy-docs.yaml \
--repo ${GITHUB_REPOSITORY:-$(gh repo view --json nameWithOwner -q .nameWithOwner)} \
--ref "{{branch}}" \
--field debug_enabled="{{debug}}" \
--field branch="{{branch}}"
echo "Check workflow status with: just gh-docs-status"
# View recent workflow runs status
[group('CI/CD')]
gh-workflow-status workflow="deploy-docs.yaml" branch=`git branch --show-current` limit="5":
#!/usr/bin/env bash
echo "Recent docs workflow runs:"
gh run list \
--workflow={{workflow}} \
--branch={{branch}} \
--limit={{limit}} \
--repo ${GITHUB_REPOSITORY:-$(gh repo view --json nameWithOwner -q .nameWithOwner)}
# Watch a specific docs workflow run
[group('CI/CD')]
gh-docs-watch run_id="":
#!/usr/bin/env bash
if [ -z "{{run_id}}" ]; then
echo "Getting latest workflow run..."
RUN_ID=$(gh run list --workflow=deploy-docs.yaml --limit=1 --json databaseId -q '.[0].databaseId' \
--repo ${GITHUB_REPOSITORY:-$(gh repo view --json nameWithOwner -q .nameWithOwner)})
echo "Watching run: $RUN_ID"
gh run watch $RUN_ID --repo ${GITHUB_REPOSITORY:-$(gh repo view --json nameWithOwner -q .nameWithOwner)}
else
gh run watch {{run_id}} --repo ${GITHUB_REPOSITORY:-$(gh repo view --json nameWithOwner -q .nameWithOwner)}
fi
# View logs for a specific docs workflow run
[group('CI/CD')]
gh-docs-logs run_id="" job="":
#!/usr/bin/env bash
REPO="${GITHUB_REPOSITORY:-$(gh repo view --json nameWithOwner -q .nameWithOwner)}"
if [ -z "{{run_id}}" ]; then
echo "Getting latest workflow run..."
RUN_ID=$(gh run list --workflow=deploy-docs.yaml --limit=1 --json databaseId -q '.[0].databaseId' --repo $REPO)
else
RUN_ID="{{run_id}}"
fi
if [ -z "{{job}}" ]; then
echo "Available jobs in run $RUN_ID:"
gh run view $RUN_ID --repo $REPO --json jobs -q '.jobs[].name'
echo ""
echo "Viewing full run logs..."
gh run view $RUN_ID --log --repo $REPO
else
echo "Viewing logs for job '{{job}}' in run $RUN_ID..."
gh run view $RUN_ID --log --repo $REPO | grep -A 100 "{{job}}"
fi
# Re-run a failed docs workflow
[group('CI/CD')]
gh-docs-rerun run_id="" failed_only="true":
#!/usr/bin/env bash
REPO="${GITHUB_REPOSITORY:-$(gh repo view --json nameWithOwner -q .nameWithOwner)}"
if [ -z "{{run_id}}" ]; then
echo "Getting latest workflow run..."
RUN_ID=$(gh run list --workflow=deploy-docs.yaml --limit=1 --json databaseId -q '.[0].databaseId' --repo $REPO)
else
RUN_ID="{{run_id}}"
fi
if [ "{{failed_only}}" = "true" ]; then
echo "Re-running failed jobs in run $RUN_ID..."
gh run rerun --failed $RUN_ID --repo $REPO
else
echo "Re-running all jobs in run $RUN_ID..."
gh run rerun $RUN_ID --repo $REPO
fi
# Cancel a running docs workflow
[group('CI/CD')]
gh-docs-cancel run_id="":
#!/usr/bin/env bash
REPO="${GITHUB_REPOSITORY:-$(gh repo view --json nameWithOwner -q .nameWithOwner)}"
if [ -z "{{run_id}}" ]; then
echo "Getting latest workflow run..."
RUN_ID=$(gh run list --workflow=deploy-docs.yaml --limit=1 --json databaseId -q '.[0].databaseId' --repo $REPO)
echo "Canceling run: $RUN_ID"
gh run cancel $RUN_ID --repo $REPO
else
gh run cancel {{run_id}} --repo $REPO
fi
# Discover packages as JSON array for CI matrix
[group('CI/CD')]
list-packages-json:
@ls -d packages/*/pyproject.toml | while read f; do \
d=$(dirname "$f"); \
n=$(basename "$d"); \
if [ -f "$d/Cargo.toml" ]; then m=true; else m=false; fi; \
printf '{"name":"%s","path":"%s","maturin":%s}\n' "$n" "$d" "$m"; \
done | jq -sc '.'
# Discover maturin (Rust/pyo3) packages as JSON array
[group('CI/CD')]
list-maturin-packages:
@just list-packages-json | jq '[.[] | select(.maturin)]'
# Sync dependencies for a package via uv
[group('CI/CD')]
ci-sync package:
cd packages/{{package}} && uv sync --all-extras --dev
# Run linting for a package
[group('CI/CD')]
ci-lint package:
cd packages/{{package}} && uv run ruff check src/
# Run tests for a package
[group('CI/CD')]
ci-test package:
cd packages/{{package}} && uv run pytest
# Run type checking for a package
[group('CI/CD')]
ci-typecheck package:
cd packages/{{package}} && uv run pyright src/
# Run all checks for a package (lint, typecheck, test)
[group('CI/CD')]
ci-check package: (ci-lint package) (ci-typecheck package) (ci-test package)
@printf "\nAll CI checks passed for {{package}}.\n"
## Conda
# Package commands (conda)
[group('conda')]
conda-build package="pnt-core":
pixi build --manifest-path=packages/{{package}}/pyproject.toml
# Create and sync conda environment with pixi
[group('conda')]
conda-env package="pnt-core":
pixi install --manifest-path=packages/{{package}}/pyproject.toml
@echo "Conda environment is ready. Activate it with 'pixi shell'"
# Update pixi lockfile
[group('conda')]
pixi-lock package="pnt-core":
pixi list --manifest-path=packages/{{package}}/pyproject.toml
pixi tree --manifest-path=packages/{{package}}/pyproject.toml
# Update conda environment
[group('conda')]
conda-lock package="pnt-core":
pixi project export conda-explicit-spec packages/{{package}}/conda/ --manifest-path=packages/{{package}}/pyproject.toml --ignore-pypi-errors
# Run tests in conda environment with pixi
[group('conda')]
conda-test package="pnt-core":
pixi run -e test --manifest-path=packages/{{package}}/pyproject.toml test
# Run linting in conda environment with pixi
[group('conda')]
conda-lint package="pnt-core":
pixi run -e lint --manifest-path=packages/{{package}}/pyproject.toml lint-check
# Run linting and fix errors in conda environment with pixi
[group('conda')]
conda-lint-fix package="pnt-core":
pixi run -e lint --manifest-path=packages/{{package}}/pyproject.toml lint
# Run type checking in conda environment with pixi
[group('conda')]
conda-type package="pnt-core":
pixi run -e types --manifest-path=packages/{{package}}/pyproject.toml types
# Run all checks in conda environment (lint, type, test)
[group('conda')]
conda-check package="pnt-core": (conda-lint package) (conda-type package) (conda-test package)
@printf "\n\033[92mAll conda checks passed!\033[0m\n"
## Containers
# Build production container image
[group('containers')]
container-build-production CONTAINER:
nix build ".#{{CONTAINER}}ProductionImage" -L
# Load production container to local Docker daemon
[group('containers')]
container-load-production CONTAINER:
nix run ".#{{CONTAINER}}ProductionImage.copyToDockerDaemon"
# Push production container manifest (requires registry auth)
[group('containers')]
container-push-production CONTAINER VERSION="0.0.0" +TAGS="":
VERSION={{VERSION}} TAGS={{TAGS}} nix run --impure ".#{{CONTAINER}}Manifest" -L
# Display container CI matrix
[group('containers')]
container-matrix:
nix eval .#containerMatrix --json | jq .
## Nix
# Enter the Nix development shell
[group('nix')]
dev:
nix develop
# Validate the Nix flake configuration for the current system
[group('nix')]
flake-check:
#!/usr/bin/env bash
set -euo pipefail
SYSTEM=$(nix eval --impure --raw --expr builtins.currentSystem)
echo "Validating flake for $SYSTEM..."
nix flake metadata
echo "Evaluating checks for $SYSTEM..."
nix eval ".#checks.$SYSTEM" --apply builtins.attrNames --json
echo "Building checks for $SYSTEM..."
for check in $(nix eval ".#checks.$SYSTEM" --apply builtins.attrNames --json | jq -r '.[]'); do
echo "Building check: $check"
nix build ".#checks.$SYSTEM.$check" --no-link -L
done
# Update all flake inputs to their latest versions
[group('nix')]
flake-update:
nix flake update
# Run CI checks locally with `om ci`
[group('nix')]
ci:
om ci
## Python
# Run tests for a package
[group('python')]
test package="pnt-core":
cd packages/{{package}} && pytest
# Run tests for all packages
[group('python')]
test-all:
#!/usr/bin/env bash
set -euo pipefail
for dir in packages/*/; do
pkg=$(basename "$dir")
echo "Testing $pkg..."
(cd "$dir" && pytest)
done
# Build a package with uv
[group('python')]
uv-build package="pnt-core":
cd packages/{{package}} && uv build
# Sync a package environment with uv
[group('python')]
uv-sync package="pnt-core":
cd packages/{{package}} && uv sync
# Update lockfile for a package
[group('python')]
uv-lock package="pnt-core":
cd packages/{{package}} && uv lock
# Run linting for a package
[group('python')]
lint package="pnt-core":
cd packages/{{package}} && ruff check src/
# Run linting for all packages
[group('python')]
lint-all:
ruff check packages/
# Run linting and fix errors for a package
[group('python')]
lint-fix package="pnt-core":
cd packages/{{package}} && ruff check --fix src/
# Run type checking for a package
[group('python')]
type package="pnt-core":
cd packages/{{package}} && pyright src/
# Run all checks for a package (lint, type, test)
[group('python')]
check package="pnt-core": (lint package) (type package) (test package)
@printf "\nAll Python checks passed for {{package}}.\n"
## Rust
# Build Rust crates for a package
[group('rust')]
cargo-build package:
cd packages/{{package}}/crates && cargo build
# Run Rust tests via cargo test
[group('rust')]
cargo-test package:
cd packages/{{package}}/crates && cargo test
# Run Rust clippy lints
[group('rust')]
cargo-clippy package:
cd packages/{{package}}/crates && cargo clippy --all-targets -- --deny warnings
# Run Rust tests via cargo-nextest
[group('rust')]
cargo-nextest package:
cd packages/{{package}}/crates && cargo nextest run --no-tests=pass
# Run all Rust checks (clippy, test)
[group('rust')]
cargo-check package: (cargo-clippy package) (cargo-test package)
@printf "\nAll Rust checks passed for {{package}}.\n"
## Secrets
# Show existing secrets using sops
[group('secrets')]
show-secrets:
@echo "=== Shared secrets (vars/shared.yaml) ==="
@sops -d vars/shared.yaml
@echo
# Edit shared secrets file
[group('secrets')]
edit-secrets:
@sops vars/shared.yaml
# Create a new sops encrypted file
[group('secrets')]
new-secret file:
@sops {{ file }}
# Export unique secrets to dotenv format using sops
[group('secrets')]
export-secrets:
@echo "# Exported from sops secrets" > .secrets.env
@sops -d vars/shared.yaml | grep -E '^[A-Z_]+:' | sed 's/: /=/' >> .secrets.env
@sort -u .secrets.env -o .secrets.env
# Run command with all shared secrets as environment variables
[group('secrets')]
run-with-secrets +command:
@sops exec-env vars/shared.yaml '{{ command }}'
# Check secrets are available in sops environment
[group('secrets')]
check-secrets:
@printf "Check sops environment for secrets\n\n"
@sops exec-env vars/shared.yaml 'env | grep -E "GITHUB|CACHIX|CLOUDFLARE" | sed "s/=.*$/=***REDACTED***/"'
# Show specific secret value from shared secrets
[group('secrets')]
get-secret key:
@sops -d vars/shared.yaml | grep "^{{ key }}:" | cut -d' ' -f2-
# Validate all sops encrypted files can be decrypted
[group('secrets')]
validate-secrets:
@echo "Validating sops encrypted files..."
@for file in $(find vars \( -name "*.yaml" -o -name "*.json" \)); do \
echo "Testing: $file"; \
sops -d "$file" > /dev/null && echo " ✅ Valid" || echo " ❌ Failed"; \
done
# Initialize sops age key for new developers
[group('secrets')]
sops-init:
@echo "Checking sops configuration..."
@if [ ! -f ~/.config/sops/age/keys.txt ]; then \
echo "Generating age key..."; \
mkdir -p ~/.config/sops/age; \
age-keygen -o ~/.config/sops/age/keys.txt; \
echo ""; \
echo "✅ Age key generated. Add this public key to .sops.yaml:"; \
grep "public key:" ~/.config/sops/age/keys.txt; \
else \
echo "✅ Age key already exists"; \
grep "public key:" ~/.config/sops/age/keys.txt; \
fi
# Add existing age key to local configuration
[group('secrets')]
sops-add-key:
#!/usr/bin/env bash
set -euo pipefail
# Ensure keys.txt exists and has proper permissions
mkdir -p ~/.config/sops/age
touch ~/.config/sops/age/keys.txt
chmod 600 ~/.config/sops/age/keys.txt
# Prompt for key description
printf "Enter age key description (e.g., 'python-nix-template [dev|ci]'): "
read -r key_description
[[ -z "${key_description}" ]] && { echo "❌ Description cannot be empty"; exit 1; }
# Prompt for public key
printf "Enter age public key (age1...): "
read -r public_key
if [[ ! "${public_key}" =~ ^age1[a-z0-9]{58}$ ]]; then
echo "❌ Invalid age public key format (must start with 'age1' and be 62 chars)"
exit 1
fi
# Prompt for private key (hidden input)
printf "Enter age private key (AGE-SECRET-KEY-...): "
read -rs private_key
echo # New line after hidden input
if [[ ! "${private_key}" =~ ^AGE-SECRET-KEY-[A-Z0-9]{59}$ ]]; then
echo "❌ Invalid age private key format"
exit 1
fi
# Check if key already exists
if grep -q "${private_key}" ~/.config/sops/age/keys.txt 2>/dev/null; then
echo "⚠️ This private key already exists in keys.txt"
exit 1
fi
# Append to keys.txt with proper formatting
{
echo ""
echo "# ${key_description}"
echo "# public key: ${public_key}"
echo "${private_key}"
} >> ~/.config/sops/age/keys.txt
echo "✅ Age key added successfully for: ${key_description}"
echo " Public key: ${public_key}"
# Add or update a secret non-interactively
[group('secrets')]
set-secret secret_name secret_value:
@sops set vars/shared.yaml '["{{ secret_name }}"]' '"{{ secret_value }}"'
@echo "✅ {{ secret_name }} has been set/updated"
# Rotate a specific secret interactively
[group('secrets')]
rotate-secret secret_name:
@echo "Rotating {{ secret_name }}..."
@echo "Enter new value for {{ secret_name }}:"
@read -s NEW_VALUE && \
sops set vars/shared.yaml '["{{ secret_name }}"]' "\"$NEW_VALUE\"" && \
echo "✅ {{ secret_name }} rotated successfully"
# Update keys for existing secrets files after adding new recipients
[group('secrets')]
updatekeys:
@for file in $(find vars \( -name "*.yaml" -o -name "*.json" \)); do \
echo "Updating keys for: $file"; \
sops updatekeys -y "$file"; \
done
@echo "✅ Keys updated for all secrets files"
# Bootstrap or rotate SOPS age keys (unified recipe for first-time and rotation)
[group('secrets')]
sops-bootstrap role='dev' method='ssh':
@scripts/sops-bootstrap.sh "{{ role }}" "{{ method }}"
# Upload SOPS_AGE_KEY to GitHub (separate from other secrets to avoid chicken-and-egg)
[group('secrets')]
sops-upload-github-key repo="":
@scripts/sops-upload-github-key.sh "{{ repo }}"
# Enumerate required secrets by parsing GitHub workflows
[group('secrets')]
sops-check-requirements:
@scripts/sops-check-requirements.sh
# Comprehensive GitHub setup (uploads everything except SOPS_AGE_KEY)
[group('secrets')]
sops-setup-github repo="":
@scripts/sops-setup-github.sh "{{ repo }}"
# Finalize key rotation by removing old keys
[group('secrets')]
sops-finalize-rotation role='dev':
@scripts/sops-finalize-rotation.sh "{{ role }}"
# Quick rotation workflow (combines bootstrap + finalize after verification)
[group('secrets')]
sops-rotate role='dev' method='ssh':
@scripts/sops-rotate.sh "{{ role }}" "{{ method }}"
## Template
# Initialize new project from template
[group('template')]
template-init template-ref:
nix --accept-flake-config run github:juspay/omnix/v1.3.2 -- init {{ template-ref }} -o new-python-project
# Verify template functionality by creating and checking a test project
[group('template')]
template-verify:
om init -t .#default ./tmp-verify-template
cd ./tmp-verify-template && nix flake check
rm -rf ./tmp-verify-template
# GCP service account for DVC
# Enable Google Drive API in GCP project
[group('secrets')]
gcp-enable-drive-api:
@echo "Enabling Google Drive API..."
@sops exec-env vars/shared.yaml 'gcloud services enable drive.googleapis.com --project="$GCP_PROJECT_ID"'
@echo "✅ Google Drive API enabled"
@echo "Verifying..."
@sops exec-env vars/shared.yaml 'gcloud services list --enabled --project="$GCP_PROJECT_ID" | grep drive || echo "⚠️ Drive API not found in enabled services"'
# Create GCP service account for DVC access (run once)
[group('secrets')]
gcp-sa-create:
@echo "Creating GCP service account for DVC..."
@sops exec-env vars/shared.yaml 'gcloud iam service-accounts create dvc-sa \
--display-name="DVC Service Account" \
--project="$GCP_PROJECT_ID"'
@echo "✅ Service account created: dvc-sa@$GCP_PROJECT_ID.iam.gserviceaccount.com"
# Grant Storage Object User role for GCS access
[group('secrets')]
gcp-sa-storage-user:
@echo "Granting Storage Object User role for GCS access..."
@sops exec-env vars/shared.yaml 'gcloud projects add-iam-policy-binding "$GCP_PROJECT_ID" \
--member="serviceAccount:dvc-sa@$GCP_PROJECT_ID.iam.gserviceaccount.com" \
--role="roles/storage.objectUser"'
@echo "✅ Storage Object User role granted"
@echo ""
@echo "⚠️ IMPORTANT: Add dvc-sa@$GCP_PROJECT_ID.iam.gserviceaccount.com as an editor to your relevant folder or bucket."
# Download service account key (for key rotation)
[group('secrets')]
gcp-sa-key-download:
@echo "Downloading service account key..."
@sops exec-env vars/shared.yaml 'gcloud iam service-accounts keys create vars/dvc-sa.tmp.json \
--iam-account=dvc-sa@"$GCP_PROJECT_ID".iam.gserviceaccount.com \
--project="$GCP_PROJECT_ID"'
# Encrypt service account key with sops
[group('secrets')]
gcp-sa-key-encrypt:
@echo "Encrypting service account key with sops..."
@sops -e vars/dvc-sa.tmp.json > vars/dvc-sa.json
@rm -f vars/dvc-sa.tmp.json
@echo "✅ Service account key encrypted and saved to vars/dvc-sa.json"
# Helper: Run any DVC command with decrypted service account
[group('secrets')]
dvc-run +command:
#!/usr/bin/env bash
set -euo pipefail
sops -d vars/dvc-sa.json > .dvc-sa.json
trap 'rm -f .dvc-sa.json' EXIT
uvx --with dvc-gdrive,dvc-gs dvc {{command}}
# List existing service account keys (for auditing)
[group('secrets')]
gcp-sa-keys-list:
@sops exec-env vars/shared.yaml 'gcloud iam service-accounts keys list \
--iam-account=dvc-sa@"$GCP_PROJECT_ID".iam.gserviceaccount.com \
--project="$GCP_PROJECT_ID"'
# Rotate service account key
[group('secrets')]
gcp-sa-key-rotate:
@echo "Rotating service account key..."
@echo "Step 1: Creating new key..."
@just gcp-sa-key-download
@echo ""
@echo "Step 2: List existing keys (note the KEY_ID to delete):"
@just gcp-sa-keys-list
@echo ""
@echo "Step 3: After verifying new key works, delete old key with:"
@echo " just gcp-sa-key-delete KEY_ID"
# Delete a specific service account key
[group('secrets')]
gcp-sa-key-delete key_id:
@sops exec-env vars/shared.yaml 'gcloud iam service-accounts keys delete {{key_id}} \
--iam-account=dvc-sa@"$GCP_PROJECT_ID".iam.gserviceaccount.com \
--project="$GCP_PROJECT_ID" --quiet'
@echo "✅ Key {{key_id}} deleted"
## Release
# Release testing with bun
[group('release')]
test-release:
bun run test-release
# Test release as if on main branch
[group('release')]
test-release-as-main:
bun run test-release:main
# Test release with explicit branch override
[group('release')]
test-release-on-current-branch:
bun run test-release:current
# Test release directly on release branch
[group('release')]
test-release-direct:
bun run test-release:direct
# Test package release
[group('release')]
test-package-release package-name="pnt-core" branch="main":
cd packages/{{package-name}} && bun run test-release -- -b {{branch}}
# Preview release version for a package (dry-run semantic-release with merge simulation)
[group('release')]
preview-version base-branch package-path:
./scripts/preview-version.sh "{{base-branch}}" "{{package-path}}"
# Run semantic-release for a package
[group('release')]
release-package package-name dry-run="false":
#!/usr/bin/env bash
set -euo pipefail
cd packages/{{package-name}}
if [ "{{dry-run}}" = "true" ]; then
npx semantic-release --dry-run --no-ci
else
echo "This will create a real release. Use dry_run=true for testing."
npx semantic-release
fi
# Update version for a specific package across all relevant files
[group('release')]
update-version package-name version:
#!/usr/bin/env bash
set -euo pipefail
PACKAGE_PATH="packages/{{package-name}}"
if [ ! -d "$PACKAGE_PATH" ]; then
echo "Error: package directory $PACKAGE_PATH does not exist"
exit 1
fi
PYPROJECT="$PACKAGE_PATH/pyproject.toml"
if [ ! -f "$PYPROJECT" ]; then
echo "Error: $PYPROJECT not found"
exit 1
fi
# Extract current version from pyproject.toml [project] section
CURRENT=$(sed -n '/^\[project\]/,/^\[/{
/^version = /p
}' "$PYPROJECT" | head -1 | sed 's/version = "\(.*\)"/\1/')
if [ -z "$CURRENT" ]; then
echo "Error: could not extract current version from $PYPROJECT"
exit 1
fi
echo "Updating {{package-name}} from $CURRENT to {{version}}"
# Update pyproject.toml [project] version
sed -i'' -e '/^\[project\]/,/^\[/ s/^version = "'"$CURRENT"'"$/version = "{{version}}"/' "$PYPROJECT"
echo " Updated $PYPROJECT [project] version"
# Update [tool.pixi.package] version if present
if grep -q '^\[tool\.pixi\.package\]' "$PYPROJECT"; then
sed -i'' -e '/^\[tool\.pixi\.package\]/,/^\[/ s/^version = "'"$CURRENT"'"$/version = "{{version}}"/' "$PYPROJECT"
echo " Updated $PYPROJECT [tool.pixi.package] version"
fi
# For maturin packages: update Cargo.toml workspace version
CARGO_TOML="$PACKAGE_PATH/Cargo.toml"
if [ -f "$CARGO_TOML" ]; then
CARGO_CURRENT=$(sed -n '/^\[workspace\.package\]/,/^\[/{
/^version = /p
}' "$CARGO_TOML" | head -1 | sed 's/version = "\(.*\)"/\1/')
if [ -n "$CARGO_CURRENT" ]; then
sed -i'' -e '/^\[workspace\.package\]/,/^\[/ s/^version = "'"$CARGO_CURRENT"'"$/version = "{{version}}"/' "$CARGO_TOML"
echo " Updated $CARGO_TOML [workspace.package] version"
fi
echo "Regenerating Cargo.lock in $PACKAGE_PATH..."
cargo generate-lockfile --manifest-path "$CARGO_TOML"
fi
echo "Running uv lock in $PACKAGE_PATH..."
uv lock --directory "$PACKAGE_PATH"
echo "Version update complete for {{package-name}}"
## Docs
# Add quartodoc extension
[group('docs')]
docs-extensions:
(cd docs && quarto add machow/quartodoc)
# Build quartodoc API reference
[group('docs')]
docs-reference:
quartodoc build --verbose --config docs/_quarto.yml
(cd docs && quartodoc interlinks)
# Build docs
[group('docs')]
docs-build: data-sync docs-reference
quarto render docs
# Preview docs locally
[group('docs')]
docs-local:
quarto preview docs --no-browser --port 7780
# Check docs
[group('docs')]
docs-check:
quarto check docs
# Run local docs deployment
[group('docs')]
docs-dev: docs-build
bunx wrangler dev
# Deploy documentation to Cloudflare Workers (production)
[group('docs')]
docs-deploy-production: docs-build
#!/usr/bin/env bash
set -euo pipefail
CURRENT_SHA=$(git rev-parse HEAD)
CURRENT_TAG=$(git rev-parse --short=12 HEAD)
CURRENT_SHORT=$(git rev-parse --short HEAD)
CURRENT_BRANCH=$(git branch --show-current)
if [ -n "${GITHUB_ACTIONS:-}" ]; then
DEPLOYER="${GITHUB_ACTOR:-github-actions}"
DEPLOY_CONTEXT="${GITHUB_WORKFLOW:-CI}"
DEPLOY_MSG="Deployed by ${DEPLOYER} from ${CURRENT_BRANCH} via ${DEPLOY_CONTEXT}"
else
DEPLOYER=$(whoami)
DEPLOY_HOST=$(hostname -s)
DEPLOY_MSG="Deployed by ${DEPLOYER} from ${CURRENT_BRANCH} on ${DEPLOY_HOST}"
fi
echo "Deploying to production from branch: ${CURRENT_BRANCH}"
echo "Current commit: ${CURRENT_SHORT}"
echo "Full SHA: ${CURRENT_SHA}"
echo "Looking for existing version with tag: ${CURRENT_TAG}"
echo "Deployment message: ${DEPLOY_MSG}"
echo ""
EXISTING_VERSION=$(sops exec-env vars/shared.yaml \
"bunx wrangler versions list --json" | \
jq -r --arg tag "$CURRENT_TAG" \
'.[] | select(.annotations["workers/tag"] == $tag) | .id' | head -1)
if [ -n "$EXISTING_VERSION" ]; then
echo "Found existing version: ${EXISTING_VERSION}"
echo " This version was already built and tested in preview"
echo " Promoting to 100% production traffic..."
echo ""
export DEPLOYMENT_MESSAGE="${DEPLOY_MSG}"
if sops exec-env vars/shared.yaml "
bunx wrangler versions deploy ${EXISTING_VERSION}@100% --yes --message \"\$DEPLOYMENT_MESSAGE\"
"; then
echo ""
echo "Successfully promoted version ${EXISTING_VERSION} to production"
echo " Tag: ${CURRENT_TAG}"
echo " Full SHA: ${CURRENT_SHA}"
echo " Deployed by: ${DEPLOY_MSG}"
echo " Production URL: https://python-nix-template.scientistexperience.net"
else
echo ""
echo "Failed to promote version ${EXISTING_VERSION}"
echo " Deployment was cancelled or failed"
exit 1
fi
else
echo "No existing version found with tag: ${CURRENT_TAG}"
echo " This should only happen if:"
echo " - This is the first deployment"
echo " - Commit was made directly on main (not recommended)"
echo " - Version was cleaned up (retention policy)"
echo ""
echo " Falling back to direct build and deploy..."
echo ""
if sops exec-env vars/shared.yaml '
bunx wrangler deploy
'; then
echo ""
echo "Built and deployed to production"
echo " Full SHA: ${CURRENT_SHA}"
echo " Deployed by: ${DEPLOY_MSG}"
echo " Production URL: https://python-nix-template.scientistexperience.net"
else
echo ""
echo "Failed to build and deploy"
exit 1
fi
fi
# Deploy documentation to Cloudflare Workers (preview)
[group('docs')]
docs-deploy-preview branch=`git branch --show-current`: docs-build
#!/usr/bin/env bash
set -euo pipefail
SAFE_BRANCH=$(echo "{{branch}}" | tr '/' '-' | tr -c 'a-zA-Z0-9-' '-' | sed 's/--*/-/g; s/^-//; s/-$//' | cut -c1-40)
COMMIT_SHA=$(git rev-parse HEAD)
COMMIT_TAG=$(git rev-parse --short=12 HEAD)
COMMIT_SHORT=$(git rev-parse --short HEAD)
COMMIT_MSG=$(git log -1 --pretty=format:'%s')
GIT_STATUS=$(git diff-index --quiet HEAD -- && echo "clean" || echo "dirty")
TAG="${COMMIT_TAG}"
MESSAGE="[{{branch}}] ${COMMIT_MSG} (${COMMIT_TAG}, ${GIT_STATUS})"
echo "Deploying preview for branch: {{branch}}"
echo "Sanitized alias: b-${SAFE_BRANCH}"
echo "Commit: ${COMMIT_SHORT} (${GIT_STATUS})"
echo "Full SHA: ${COMMIT_SHA}"
echo "Tag: ${COMMIT_TAG}"
echo "Message: ${COMMIT_MSG}"
echo ""
export VERSION_TAG="${TAG}" VERSION_MESSAGE="${MESSAGE}" SAFE_BRANCH="${SAFE_BRANCH}"
sops exec-env vars/shared.yaml '
bunx wrangler versions upload \
--tag "$VERSION_TAG" \
--message "$VERSION_MESSAGE" \
--preview-alias "b-${SAFE_BRANCH}"
'
echo ""
echo "Version uploaded successfully"
echo " Tag: ${COMMIT_TAG}"
echo " Full SHA: ${COMMIT_SHA}"
echo " Message: ${MESSAGE}"
echo " Preview URL: https://b-${SAFE_BRANCH}-python-nix-template.sciexp.workers.dev"
# List recent Cloudflare Workers versions
[group('docs')]
docs-versions:
sops exec-env vars/shared.yaml "bunx wrangler versions list"
# List recent Cloudflare Workers deployments
[group('docs')]
docs-deployments:
sops exec-env vars/shared.yaml "bunx wrangler deployments list"
# Tail live logs from Cloudflare Workers
[group('docs')]
docs-tail:
sops exec-env vars/shared.yaml "bunx wrangler tail"
# Sync data from drive (using encrypted service account)
[group('docs')]
data-sync:
#!/usr/bin/env bash
set -euo pipefail
echo "Decrypting service account for DVC..."
sops -d vars/dvc-sa.json > .dvc-sa.json
trap 'rm -f .dvc-sa.json' EXIT
uvx --with dvc-gdrive,dvc-gs dvc pull --force --allow-missing
echo "✅ DVC data synced"
# docs-sync: docs-build
# Sync docs freeze data to DVC remote
[group('docs')]
docs-sync:
#!/usr/bin/env bash
set -euo pipefail
echo "Syncing docs freeze data to DVC remote..."
sops -d vars/dvc-sa.json > .dvc-sa.json
chmod 600 .dvc-sa.json
trap 'rm -f .dvc-sa.json' EXIT
uvx --with dvc-gdrive,dvc-gs dvc status
uvx --with dvc-gdrive,dvc-gs dvc add docs/_freeze -v
uvx --with dvc-gdrive,dvc-gs dvc push
uvx --with dvc-gdrive,dvc-gs dvc status
git status
printf "\n\033[92mCommit relevant updates to the docs/_freeze.dvc lock file to the git repo\033[0m\n"