-
Notifications
You must be signed in to change notification settings - Fork 490
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
update README.md, fix make test
, add circle.yml
#23
Merged
Merged
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
961ac6d
update README.md, fix `make test`, add circle.yml
tiancaiamao 396005b
address comment
tiancaiamao b55891c
Merge branch 'master' into update-parser
tiancaiamao aa84a57
add build.sh
tiancaiamao f48f2e5
address comment
tiancaiamao 736d721
Update README.md
CaitinChen 06a2520
Update README.md
CaitinChen 84d0b17
Update README.md
CaitinChen 4f4a54f
Update README.md
CaitinChen 3ecf275
Update README.md
CaitinChen 9f505fd
Update README.md
CaitinChen 07f3221
Update README.md
CaitinChen 19b5238
Update README.md
CaitinChen 77d8be8
Update README.md
CaitinChen 3b88e24
Update README.md
CaitinChen 312c9f0
Update README.md
CaitinChen 3e33dcb
Update README.md
CaitinChen 8f6e31d
Update README.md
CaitinChen 74ea786
Update README.md
CaitinChen 77784dd
Update README.md
tiancaiamao File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,3 +2,5 @@ bin/ | |
y.go | ||
*.output | ||
.idea/ | ||
go.mod | ||
go.sum |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,52 @@ | ||
# parser | ||
|
||
TiDB SQL Parser | ||
|
||
## How to update parser for TiDB | ||
|
||
Suppose you want to pull a request to TiDB, and the PR needs to change the parser, here is how to do it. | ||
tiancaiamao marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Step 1, make changes in your parser repository | ||
tiancaiamao marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Fork this repository to your own account, commit the changes to your repository. | ||
tiancaiamao marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
tiancaiamao marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* Don't forget to run `make test` before you commit! | ||
* Make sure the `parser.go` is updated. | ||
kennytm marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Suppose the forked repository is `https://github.com/your-repo/parser`. | ||
|
||
### Step 2, let TiDB use your parser changes and run CI | ||
tiancaiamao marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
In your TiDB repository, modify the `go.mod` file, remove `github.com/pingcap/parser` from the `require` instruction, add a new line at the end of file like this: | ||
tiancaiamao marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
``` | ||
replace github.com/pingcap/parser => github.com/your-repo/parser v0.0.0-20181102150703-4acd198f5092 | ||
``` | ||
|
||
This change tells TiDB to use the modified parser from your repository. | ||
|
||
You can get correct version information by running this command in your TiDB directory: | ||
tiancaiamao marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
``` | ||
GO111MODULE=on go get -u github.com/your-repo/parser@master | ||
``` | ||
|
||
If you get some error output, never mind. You can still edit the `go.mod` file manually. | ||
tiancaiamao marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Pull a request to TiDB. | ||
tiancaiamao marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Step 3, merge the parser to this repository | ||
tiancaiamao marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Pull a request to this repository. **Link the related PR in TiDB in your PR description or comment**. | ||
tiancaiamao marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The PR will be reviewed, if everything goes well, it will be merged. | ||
tiancaiamao marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Step 4, update TiDB to use the latest parser | ||
tiancaiamao marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
In your TiDB pull request, modify the `go.mod` file manually or use this command: | ||
|
||
``` | ||
GO111MODULE=on go get -u github.com/pingcap/parser@master | ||
``` | ||
|
||
Make sure the `replace` instruction is changed back to the `require` instruction and the version is latest. | ||
tiancaiamao marked this conversation as resolved.
Show resolved
Hide resolved
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
version: 2 | ||
|
||
jobs: | ||
build: | ||
docker: | ||
- image: golang:1.11 | ||
working_directory: /go/src/github.com/pingcap/parser | ||
steps: | ||
- checkout | ||
- run: | ||
kennytm marked this conversation as resolved.
Show resolved
Hide resolved
|
||
name: "Build & Test" | ||
command: make test |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how about
make test
failured situation? it seem re-runmake test
will meet error.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done