-
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
69 additions
and
60 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 |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Hacking guide | ||
|
||
## Development dependencies | ||
|
||
Additional dependencies needed for development: | ||
|
||
* [golangci-lint](https://golangci-lint.run/usage/install/#local-installation) | ||
|
||
* [stringer](https://github.com/golang/tools) | ||
|
||
`go install golang.org/x/tools/cmd/stringer@latest` | ||
|
||
## Makefile targets | ||
|
||
Update and build everything: | ||
|
||
``` | ||
make | ||
``` | ||
|
||
Run specific step: | ||
|
||
``` | ||
make gen|build|lint|test|testall | ||
``` | ||
|
||
Update go modules: | ||
|
||
``` | ||
make tidy | ||
``` | ||
|
||
Format code: | ||
|
||
``` | ||
make fmt | ||
``` | ||
|
||
## Making release | ||
|
||
To release a new version: | ||
|
||
* Create git tag | ||
|
||
``` | ||
./make_tag.py --push <remote> <version> | ||
``` | ||
e.g. | ||
``` | ||
./make_tag.py --push origin 1.2.3 | ||
``` | ||
You can omit `--push origin` to only create a tag locally without pushing it to github. | ||
* Wait until "Release" CI job completes and creates GitHub release draft. | ||
* Edit GitHub release created by CI and publish it. |
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
File renamed without changes.