@@ -20,13 +20,14 @@ nix run .#trigger-nix-build
2020```
2121
2222This will:
23+
2324- Trigger a GitHub Actions workflow
2425- Build PostgreSQL and extensions
2526- Run nix flake check tests (evaluation of nix code, pg_regress and migrations tests)
2627- Cache the results in the Supabase Nix binary cache
2728- Watch the workflow progress until completion
2829
29- The workflow will run on the branch you're currently on.
30+ The workflow will run on the branch you're currently on.
3031
3132If you're on a feature different branch, you'll be prompted to confirm before proceeding.
3233
@@ -46,6 +47,7 @@ aws-vault exec <profile-name> -- nix run .#build-test-ami orioledb-17
4647```
4748
4849This will:
50+
4951- Build two AMI stages using Packer
5052- Clean up temporary instances after AMI builds
5153- Output the final AMI name (e.g., ` supabase-postgres-abc123 ` )
@@ -62,13 +64,15 @@ nix run .#run-testinfra -- --aws-vault-profile <profile-name> --ami-name supabas
6264```
6365
6466This will:
67+
6568- Create a Python virtual environment
6669- Install required Python packages
6770- Create an EC2 instance from the AMI
6871- Run the test suite
6972- Automatically terminate the EC2 instance when done
7073
7174The script handles:
75+
7276- Setting up AWS credentials via aws-vault
7377- Creating and managing the Python virtual environment
7478- Running the tests
@@ -85,6 +89,7 @@ aws-vault exec <profile-name> -- nix run .#cleanup-ami supabase-postgres-abc123
8589```
8690
8791This will:
92+
8893- Deregister the AMI
8994- Clean up any associated resources
9095
@@ -109,26 +114,29 @@ This will:
109114### Environment Variables
110115
111116The following environment variables are used:
117+
112118- ` AWS_VAULT ` : AWS Vault profile name (default: staging)
113119- ` AWS_REGION ` : AWS region (default: ap-southeast-1)
114120- ` AMI_NAME ` : Name of the AMI to test
115121
116122## Best Practices
117123
1181241 . ** Branch Management**
119- - Use feature branches for development
120- - Merge to develop for testing
121- - Use release branches for version-specific changes
125+
126+ - Use feature branches for development
127+ - Merge to develop for testing
128+ - Use release branches for version-specific changes
122129
1231302 . ** Resource Cleanup**
124- - Always run the cleanup step after testing
125- - Monitor AWS console for any lingering resources
126- - Use the cleanup-ami command when done with an AMI
131+
132+ - Always run the cleanup step after testing
133+ - Monitor AWS console for any lingering resources
134+ - Use the cleanup-ami command when done with an AMI
127135
1281363 . ** Testing**
129- - Run tests locally before pushing changes
130- - Verify AMI builds before running testinfra
131- - Check test output for any warnings or errors
137+ - Run tests locally before pushing changes
138+ - Verify AMI builds before running testinfra
139+ - Check test output for any warnings or errors
132140
133141## Additional Commands
134142
@@ -138,4 +146,4 @@ nix run .#show-commands
138146
139147# Update README with latest command information
140148nix run .# update-readme
141- ```
149+ ```
0 commit comments