Skip to content

Commit beff06c

Browse files
committed
docs: update docs
1 parent 0417593 commit beff06c

File tree

1 file changed

+25
-24
lines changed

1 file changed

+25
-24
lines changed

nix/docs/updating-pgrx-extensions.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,31 @@ Updating a pgrx extension can involve one or more of these changes:
1212

1313
Each scenario requires different file changes. This guide covers all three.
1414

15+
16+
## Quick Reference: File Locations
17+
18+
| Purpose | File |
19+
|---------|------|
20+
| Extension versions | `nix/ext/versions.json` |
21+
| Extension-specific config | `nix/ext/<name>/default.nix` |
22+
| pgrx versions + Rust mappings | `nix/cargo-pgrx/versions.json` |
23+
| cargo-pgrx package definitions | `nix/cargo-pgrx/default.nix` |
24+
| pgrx extension builder | `nix/cargo-pgrx/mkPgrxExtension.nix` |
25+
| Overlays (buildPgrxExtension_*) | `nix/overlays/default.nix` |
26+
| Rust toolchain source | `flake.nix` (rust-overlay input) |
27+
| Pinned rust-overlay version | `flake.lock` |
28+
29+
---
30+
31+
## Summary: Which Scenario Am I In?
32+
33+
| Situation | Scenario |
34+
|-----------|----------|
35+
| Same pgrx and Rust as previous version | 1 - Extension only |
36+
| Extension's Cargo.toml has newer pgrx | 2 - Extension + pgrx |
37+
| Extension requires Rust version not in rust-overlay | 3 - Full stack update |
38+
| "attribute missing" error for Rust version | 3 - Need `nix flake update rust-overlay` |
39+
1540
---
1641

1742
## 1. Updating Extension Version Only
@@ -346,27 +371,3 @@ Some extensions (like wrappers) have git dependencies that require `outputHashes
346371
2. Add any new git dependencies with their calculated hashes
347372

348373
---
349-
350-
## Quick Reference: File Locations
351-
352-
| Purpose | File |
353-
|---------|------|
354-
| Extension versions | `nix/ext/versions.json` |
355-
| Extension-specific config | `nix/ext/<name>/default.nix` |
356-
| pgrx versions + Rust mappings | `nix/cargo-pgrx/versions.json` |
357-
| cargo-pgrx package definitions | `nix/cargo-pgrx/default.nix` |
358-
| pgrx extension builder | `nix/cargo-pgrx/mkPgrxExtension.nix` |
359-
| Overlays (buildPgrxExtension_*) | `nix/overlays/default.nix` |
360-
| Rust toolchain source | `flake.nix` (rust-overlay input) |
361-
| Pinned rust-overlay version | `flake.lock` |
362-
363-
---
364-
365-
## Summary: Which Scenario Am I In?
366-
367-
| Situation | Scenario |
368-
|-----------|----------|
369-
| Same pgrx and Rust as previous version | 1 - Extension only |
370-
| Extension's Cargo.toml has newer pgrx | 2 - Extension + pgrx |
371-
| Extension requires Rust version not in rust-overlay | 3 - Full stack update |
372-
| "attribute missing" error for Rust version | 3 - Need `nix flake update rust-overlay` |

0 commit comments

Comments
 (0)