Skip to content

Commit fb7721e

Browse files
Update README with metadata transition changes
- Use 'evolution.json' instead of 'proposals.json' - Add warning that the schema is in a transition period
1 parent f4b7c3a commit fb7721e

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ The `swift-evolution-metadata-extractor` tool reads the main branch of the `swif
66

77
In addition to the extraction tool, this package vends the `EvolutionMetadataModel` library which provides types for encoding and decoding evolution metadata JSON files. This library is intended for use by clients of the metadata file that drives the evolution dashboard.
88

9+
> [!WARNING]
10+
> The schema of the metadata generated by this tool is in the midst of a transition, detailed in this thread in the Swift forums: [Swift Evolution Metadata Transition](https://forums.swift.org/t/swift-evolution-metadata-transition/71387). Until the transition period ends in late July 2024, the generated `evolution.json` file and `EvolutionMetadataModel` types will contain properties that will be removed at the end of the transition. Please see the Swift forum thread for full details.
11+
912
## Usage
1013

1114
`swift-evolution-metadata-extractor`
@@ -14,7 +17,7 @@ Running the command with no arguments will do the following:
1417
1. Fetch listing of current proposals from `swift-evolution` repository
1518
2. Fetch previous metadata results from `swift.org`
1619
3. Fetch and extract metadata from proposals with changes
17-
4. Write the extracted metadata to a `proposal.json` file in the same directory as the command
20+
4. Write the extracted metadata to a `evolution.json` file in the same directory as the command
1821

1922
The default behavior can be configured in various ways.
2023

@@ -28,7 +31,7 @@ If the specified path does not exist, the tool will attempt to create the necess
2831

2932
`swift-evolution-metadata-extractor --output-path ~/Desktop`
3033

31-
> Will write output to `~/Desktop/proposals.json`
34+
> Will write output to `~/Desktop/evolution.json`
3235
3336
- Use a path ending with a file extension to specify path and file name:
3437

0 commit comments

Comments
 (0)