Skip to content

Commit 3abdb44

Browse files
committed
docs(release): clarify maintenance runbooks
- Remove duplicated metadata update guidance from the README - Clarify when to run metadata freshness checks manually - Replace ambiguous validation wording with wrapper script commands
1 parent 3f7100b commit 3abdb44

3 files changed

Lines changed: 10 additions & 26 deletions

File tree

README.md

Lines changed: 6 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -407,34 +407,18 @@ swift scripts/updateMetadata.swift <libphonenumber-version>
407407

408408
Use `--only main,geocoding` or `--skip carrier,timezones` when the release intentionally covers only specific metadata families. See the [release runbook](docs/RELEASE_RUNBOOK.md) for the full release flow.
409409

410-
### Main And Short-Number Metadata
410+
### Direct Metadata Scripts
411411

412-
Run the metadata generator from the `scripts` directory:
413-
414-
```bash
415-
cd scripts
416-
./metadataGenerator.swift <libphonenumber-version> --pretty
417-
```
418-
419-
This downloads metadata from Google's libphonenumber repository, updates the generated Objective-C metadata files from compact JSON, and writes pretty-printed `generatedJSON` files for review.
420-
421-
### Geocoding Metadata
422-
423-
Generate SQLite geocoding databases with the command-line updater:
412+
Use the individual generators only when debugging or intentionally updating one metadata family outside the normal release flow:
424413

425414
```bash
415+
swift scripts/metadataGenerator.swift <libphonenumber-version> --pretty
426416
swift scripts/updateGeocodingMetadata.swift <libphonenumber-version> --replace-bundle
417+
swift scripts/updateCarrierMetadata.swift <libphonenumber-version> --replace-bundle
418+
swift scripts/updateTimeZonesMetadata.swift <libphonenumber-version> --replace-bundle
427419
```
428420

429-
Examples:
430-
431-
```bash
432-
swift scripts/updateGeocodingMetadata.swift 9.0.29 --replace-bundle
433-
swift scripts/updateGeocodingMetadata.swift master --output /tmp/geocoding
434-
swift scripts/updateGeocodingMetadata.swift --source /tmp/libphonenumber --output /tmp/geocoding
435-
```
436-
437-
Use `--output` to inspect generated databases before replacing the checked-in bundle. Use `--source` when you already have a local Google libphonenumber checkout or an extracted `resources/geocoding` directory.
421+
Use `--output` to inspect generated review artifacts before replacing checked-in bundles. Use `--source` with the individual scripts when you already have a local Google libphonenumber checkout or extracted resource directory.
438422

439423
## Validation
440424

docs/RELEASE_RUNBOOK.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Run CocoaPods lint for every shipped podspec when packaging, dependency, or rele
115115
swift scripts/publishPodspecs.swift --lint
116116
```
117117

118-
Re-run freshness after the metadata update to confirm the checked-in metadata matches the selected upstream ref:
118+
The all-in-one updater runs the freshness check after checked-in updates. Run it manually only if you used `--skip-freshness-check` or individual generator scripts:
119119

120120
```bash
121121
swift scripts/checkMetadataFreshness.swift --current-ref <metadata-ref> --output .build/metadata-freshness

docs/TESTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,16 +94,16 @@ For a small implementation or test-only change:
9494
For metadata updates:
9595

9696
- Use a patch version for metadata-only releases. Use a minor version only when the change also adds public API, new modules, or additive behavior beyond metadata freshness.
97-
- `swift scripts/checkMetadataFreshness.swift --current-ref <metadata-ref> --output .build/metadata-freshness`
97+
- `swift scripts/checkMetadataFreshness.swift --output .build/metadata-freshness`
98+
- `swift scripts/updateMetadata.swift <metadata-ref> --dry-run`
9899
- `swift scripts/checkUpstreamTestParity.swift --upstream-ref <metadata-ref>`
99100
- `swift scripts/checkUpstreamAPIParity.swift --upstream-ref <metadata-ref>`
100-
- `swift scripts/updateMetadata.swift <metadata-ref> --dry-run`
101101
- `scripts/testGeocodingMetadataUpdater.sh` if the geocoding updater changed.
102102
- Update `docs/METADATA_UPDATE_LOG.md` with the upstream comparison and validation results.
103103
- `swift test`
104104
- `LC_ALL=ko_KR.UTF-8 LANG=ko_KR.UTF-8 swift test`
105105
- `swift build -c release`
106-
- all three Xcode schemes
106+
- `swift scripts/testXcodeSchemes.swift`
107107
- `git diff --check`
108108

109109
For public API or parser/formatter behavior changes:

0 commit comments

Comments
 (0)