-
Notifications
You must be signed in to change notification settings - Fork 489
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update README.md, fix
make test
, add circle.yml
- Loading branch information
1 parent
f0db1d1
commit 961ac6d
Showing
7 changed files
with
73 additions
and
322 deletions.
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. | ||
|
||
### Step 1, make changes in your parser repository | ||
|
||
Fork this repository to your own account, commit the changes to your repository. | ||
|
||
* Don't forget to run `make test` before you commit! | ||
* Make sure the `parser.go` is updated. | ||
|
||
Suppose the forked repository is `https://github.com/your-repo/parser`. | ||
|
||
### Step 2, let TiDB use your parser changes and run CI | ||
|
||
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: | ||
|
||
``` | ||
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: | ||
|
||
``` | ||
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. | ||
|
||
Pull a request to TiDB. | ||
|
||
### Step 3, merge the parser to this repository | ||
|
||
Pull a request to this repository. **Link the related PR in TiDB in your PR description or comment**. | ||
|
||
The PR will be reviewed, if everything goes well, it will be merged. | ||
|
||
### Step 4, update TiDB to use the latest parser | ||
|
||
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. |
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: | ||
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.