If you're new to provider development, a good place to start is the Extending Terraform docs.
Acceptance tests require a running instance of Grafana. You can either handle
running an instance of Grafana yourself or use
If you choose
make testacc-docker. This is the simplest
option, but often not the quickest.
Alternatively you can use the
testacc target which will use your local
# Assuming Grafana was run with: # docker run --rm -p 3000:3000 grafana/grafana GRAFANA_URL=http://localhost:3000 \ GRAFANA_AUTH=admin:admin \ GRAFANA_ORG_ID=1 \ make testacc
To run tests for resources which are available only for Grafana Enterprise, running instance of Grafana Enterprise is required. It is only possible to run tests for Grafana Enterprise using local environment.
# Assuming Grafana was run with: # docker run --rm -p 3000:3000 grafana/grafana GRAFANA_URL=http://localhost:3000 \ GRAFANA_AUTH=admin:admin \ GRAFANA_ORG_ID=1 \ make testacc-enterprise
Documentation is generated with
files are in
docs/ and should not be updated manually. They are derived from:
go generate to update generated docs.
Currently there are a few manual steps to this:
Update the changelog:
RELEASE_VERSION=v... \ CHANGELOG_GITHUB_TOKEN=... \ make changelog
This will commit the changelog locally.
Review generated changelog and push:
View the committed changelog with
git show. If all is well
git push origin master.
Kick off the release:
RELEASE_VERSION=v... \ make release
Once the command exits, you can monitor the rest of the process on the Actions UI.
The Action creates the release, but leaves it in "draft" state. Open it up in a browser and if all looks well, mash the publish button.