Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

59 lines (37 loc) · 1.4 KB
Raw

Contributing Guidelines

This document is a guide to help you through the process of contributing to grizzly.

Developing the extension

Create a fork

Fork, then clone the repository:

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

go mod vendor

Building from sources

To build Grizzly locally, inside a checkout, run:

make dev

Run locally

To run Grizzly locally, use:

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.