-
Notifications
You must be signed in to change notification settings - Fork 73
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
Add a contributing and releasing guide #500
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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 |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Contributing Guidelines | ||
|
||
This document is a guide to help you through the process of contributing to `grizzly`. | ||
|
||
## Developing the extension | ||
|
||
### Create a fork | ||
|
||
[Fork][fork], then clone the repository: | ||
|
||
```shell | ||
git clone [email protected]:{your_github_username}/grizzly.git | ||
cd grizzly | ||
git remote add upstream https://github.com/grafana/grizzly.git | ||
git fetch upstream | ||
``` | ||
|
||
### Install dependencies | ||
|
||
```shell | ||
go mod vendor | ||
``` | ||
|
||
### Building from sources | ||
|
||
To build Grizzly locally, inside a checkout, run: | ||
|
||
```shell | ||
make dev | ||
``` | ||
|
||
### Run locally | ||
|
||
To run Grizzly locally, use: | ||
|
||
```shell | ||
go run cmd/grr/*.go | ||
``` | ||
|
||
## Run the tests | ||
|
||
There are both unit tests and integration tests in this repo. | ||
|
||
Unit tests can be run using `make test`. Integration tests are run with | ||
`make integration`. This command spins up a Grafana instance with certain config | ||
and provisioned resources, so the integration tests can run against it. | ||
|
||
You can also manually execute `make run-test-image-locally` and run the tests | ||
for debugging. | ||
|
||
## Releasing grizzly | ||
|
||
Releasing is done as follows: | ||
|
||
1. Trigger the release pipeline by creating and pushing a tag: `git tag {version} && git push origin {version}` | ||
2. The pipeline publishes docker images of grizzly and creates a GitHub release. The latter, however, is marked as draft and as such needs to be reviewed and updated with change notes before being published. | ||
|
||
|
||
[fork]: https://github.com/grafana/grizzly/fork |
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.
there's also
make integration
to run integration tests.