|
| 1 | +# TagSpecs v0.4.0 Deprecation Removal Checklist |
| 2 | + |
| 3 | +**Target Version:** v5.2.7 |
| 4 | +**Timeline:** Remove after v5.2.5 and v5.2.6 releases |
| 5 | + |
| 6 | +This document provides a step-by-step checklist for removing the deprecated TagSpecs v0.4.0 format support. |
| 7 | + |
| 8 | +## Removal Checklist |
| 9 | + |
| 10 | +### 1. Delete Legacy Module |
| 11 | + |
| 12 | +- [ ] Delete file: `crates/djls-conf/src/tagspecs/legacy.rs` |
| 13 | + |
| 14 | +### 2. Update `tagspecs.rs` |
| 15 | + |
| 16 | +- [ ] Remove line: `pub mod legacy;` from `crates/djls-conf/src/tagspecs.rs` |
| 17 | +- [ ] Remove the deprecation comment above it |
| 18 | + |
| 19 | +### 3. Update `lib.rs` |
| 20 | + |
| 21 | +- [ ] Remove the `deserialize_tagspecs` function from `crates/djls-conf/src/lib.rs` |
| 22 | +- [ ] Remove the deprecation comment above it |
| 23 | +- [ ] Change `Settings` struct field from: |
| 24 | + ```rust |
| 25 | + #[serde(default, deserialize_with = "deserialize_tagspecs")] |
| 26 | + tagspecs: TagSpecDef, |
| 27 | + ``` |
| 28 | + to: |
| 29 | + ```rust |
| 30 | + #[serde(default)] |
| 31 | + tagspecs: TagSpecDef, |
| 32 | + ``` |
| 33 | + |
| 34 | +### 4. Update Dependencies |
| 35 | + |
| 36 | +- [ ] Consider if `tracing` is still needed in `crates/djls-conf/Cargo.toml` |
| 37 | + - If only used for deprecation warning, remove it |
| 38 | + - If used elsewhere, keep it |
| 39 | + |
| 40 | +### 5. Remove Tests |
| 41 | + |
| 42 | +- [ ] Remove the entire `mod legacy_format` test section from `crates/djls-conf/src/lib.rs` |
| 43 | + - Look for the comment: `// DEPRECATION TESTS: Remove in v5.2.7` |
| 44 | + - Delete everything in the `mod legacy_format` module |
| 45 | + |
| 46 | +### 6. Update Documentation |
| 47 | + |
| 48 | +- [ ] Remove deprecation warning from `crates/djls-conf/TAGSPECS.md` |
| 49 | + - Delete the "DEPRECATED FORMAT" callout at the top |
| 50 | + - Delete the entire "Migration from v0.4.0" section at the end |
| 51 | + |
| 52 | +- [ ] Remove deprecation warning from `docs/configuration.md` |
| 53 | + - Delete the "DEPRECATED FORMAT" warning in the `tagspecs` section |
| 54 | + |
| 55 | +### 7. Update CHANGELOG |
| 56 | + |
| 57 | +- [ ] Add removal notice to CHANGELOG.md under v5.2.7: |
| 58 | + ```markdown |
| 59 | + ## [5.2.7] |
| 60 | + |
| 61 | + ### Removed |
| 62 | + |
| 63 | + - TagSpecs v0.4.0 flat format support (deprecated in v5.2.5) |
| 64 | + ``` |
| 65 | + |
| 66 | +- [ ] Move the deprecation notice from "Deprecated" section to "Removed" section |
| 67 | + |
| 68 | +### 8. Verification |
| 69 | + |
| 70 | +- [ ] Run all tests: `cargo test` |
| 71 | +- [ ] Build project: `cargo build` |
| 72 | +- [ ] Try using old format in config (should fail with clear error) |
| 73 | +- [ ] Verify new format still works |
| 74 | + |
| 75 | +### 9. Cleanup |
| 76 | + |
| 77 | +- [ ] Delete this checklist file: `DEPRECATION_REMOVAL_v5.2.7.md` |
| 78 | + |
| 79 | +## Files Affected |
| 80 | + |
| 81 | +Summary of all files that will be modified: |
| 82 | + |
| 83 | +1. **Deleted:** |
| 84 | + - `crates/djls-conf/src/tagspecs/legacy.rs` |
| 85 | + - `DEPRECATION_REMOVAL_v5.2.7.md` (this file) |
| 86 | + |
| 87 | +2. **Modified:** |
| 88 | + - `crates/djls-conf/src/tagspecs.rs` |
| 89 | + - `crates/djls-conf/src/lib.rs` |
| 90 | + - `crates/djls-conf/Cargo.toml` (maybe) |
| 91 | + - `crates/djls-conf/TAGSPECS.md` |
| 92 | + - `docs/configuration.md` |
| 93 | + - `CHANGELOG.md` |
| 94 | + |
| 95 | +## Notes |
| 96 | + |
| 97 | +- All legacy code is isolated in clearly marked sections |
| 98 | +- Removing these sections should not affect any other functionality |
| 99 | +- The new v0.5.0 format implementation remains unchanged |
0 commit comments