Draft compact index documentation #362
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
martinemde
force-pushed
the
martinemde/compact-index-documentation
branch
5 times, most recently
from
13d3440 to
8e8bdfe
Compare
segiddins
approved these changes
Apr 10, 2024
rubygems-org-compact-index-api.md
Outdated
|
|
||
| The format of the `versions` file uses one line per gem at computation time, with additional lines appended to the end that may include new or yanked versions of a gem already present earlier in the file. | ||
|
|
||
| The first line is a created_at timestamp in IOS8601 format. |
There was a problem hiding this comment.
I think for all compact index files, everything up to the --- is opaque metadata. Furthermore, the opaque metadata and --- separator line are optional.
There was a problem hiding this comment.
If the dashes are optional and your are reading the file, you can't look for the --- as the start of the parseable data. Do you just try to read lines until you can parse one? It seems hard to parse reliably if the --- is optional.
There was a problem hiding this comment.
deivid-rodriguez
approved these changes
Apr 11, 2024
rubygems-org-compact-index-api.md
Outdated
| 5. **`[(COMMA)DEPENDENCY]`** - (optional) A `,` (comma) character, indicating that another DEPENDENCY will follow. Read comma delimited DEPENCENCY chunks until the `|` (pipe) character is encountered. | ||
| 6. **`(PIPE)`** - The `|` (pipe) character. | ||
| 7. **`METADATA`** - Additional information about the gem, which always includes at least the SHA256 checksum. METADATA may contain spaces. See below for format. | ||
| 5. **`[(COMMA)METADATA]`** - (optional) A `,` (comma) character, indicating that another METADATA will follow. Read comma delimited METADATA chunks until the end of the line. |
There was a problem hiding this comment.
Numbering in this list seems odd?
There was a problem hiding this comment.
lol, 1 2 2 3 5 6 7 5. Can you guess the next number is this sequence?
martinemde
force-pushed
the
martinemde/compact-index-documentation
branch
from
e518a99 to
59ce84c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please offer fixes or clarification if I got any of this wrong.