[doc] Add a table to map release tags from the compiler to SwiftSyntax. #16
Conversation
This file contains hidden or 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
|
@swift-ci please test |
akyrtzi
requested changes
Sep 18, 2018
README.md
Outdated
| @@ -26,7 +26,13 @@ let package = Package( | |||
| ) | |||
| ``` | |||
|
|
|||
| Replace `<#Specify Release tag#>` by the version of SwiftSyntax that you want to use. Tags will be created for every release of the compiler in the form `swift-4.2-RELEASE` and for every nightly build in the form `swift-4.2-DEVELOPMENT-SNAPSHOT-2018-08-25-a`. | |||
| Replace `<#Specify Release tag#>` by the version of SwiftSyntax that you want to use (see the following table for mapping details). Tags will be created for every release of the compiler in the form `swift-4.2-RELEASE` and for every nightly build in the form `swift-4.2-DEVELOPMENT-SNAPSHOT-<DATE>`. | |||
There was a problem hiding this comment.
Tags will be created for every... is confusing and does not reflect the change in the tagging scheme, recommend to change to:
Tags will be created for every nightly build in the form `<SwiftSyntax Release Tag>-DEVELOPMENT-SNAPSHOT-<DATE>`.
|
@akyrtzi Changed. Mind taking another look? |
|
I'm a little confused personally. Does this need to match the version of |
akyrtzi
approved these changes
Sep 18, 2018
|
@mdiep That's correct. Swift-syntax relies on compiler (swiftc) to generate syntax trees to deserialize. For every major releases of Swift, Syntax tree generated from the compiler can vary structurally. So we have to agree on compatible versions so the parser can generate the tree swift-syntax recognizes, and vice versa. If you have any trouble building your tool on top of swift-syntax, please let us know :) |
adevress
pushed a commit
to adevress/swift-syntax
that referenced
this pull request
Jan 14, 2024
Lint pipeline improvements; fix enabling/disabling of lint rules.
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.
No description provided.