|
@@ -0,0 +1,89 @@
|
|
|
|
|
+# Guide to Upgrading Dependencies
|
|
|
|
|
+
|
|
|
|
|
+Upgrading Go or Node.js requires making changes in many different files. See below for a list and explanation for each.
|
|
|
|
|
+
|
|
|
|
|
+## Go
|
|
|
|
|
+
|
|
|
|
|
+- CircleCi
|
|
|
|
|
+- `grafana/build-container`
|
|
|
|
|
+- Appveyor
|
|
|
|
|
+- Dockerfile
|
|
|
|
|
+
|
|
|
|
|
+## Node.js
|
|
|
|
|
+
|
|
|
|
|
+- CircleCI
|
|
|
|
|
+- `grafana/build-container`
|
|
|
|
|
+- Appveyor
|
|
|
|
|
+- Dockerfile
|
|
|
|
|
+
|
|
|
|
|
+## Go Dependencies
|
|
|
|
|
+
|
|
|
|
|
+Updated using `dep`.
|
|
|
|
|
+
|
|
|
|
|
+- `Gopkg.toml`
|
|
|
|
|
+- `Gopkg.lock`
|
|
|
|
|
+
|
|
|
|
|
+## Node.js Dependencies
|
|
|
|
|
+
|
|
|
|
|
+Updated using `yarn`.
|
|
|
|
|
+
|
|
|
|
|
+- `package.json`
|
|
|
|
|
+
|
|
|
|
|
+## Where to make changes
|
|
|
|
|
+
|
|
|
|
|
+### CircleCI
|
|
|
|
|
+
|
|
|
|
|
+Our builds run on CircleCI through our build script.
|
|
|
|
|
+
|
|
|
|
|
+#### Files
|
|
|
|
|
+
|
|
|
|
|
+- `.circleci/config.yml`.
|
|
|
|
|
+
|
|
|
|
|
+#### Dependencies
|
|
|
|
|
+
|
|
|
|
|
+- nodejs
|
|
|
|
|
+- golang
|
|
|
|
|
+- grafana/build-container (our custom docker build container)
|
|
|
|
|
+
|
|
|
|
|
+### grafana/build-container
|
|
|
|
|
+
|
|
|
|
|
+The main build step (in CircleCI) is built using a custom build container that comes pre-baked with some of the neccesary dependencies.
|
|
|
|
|
+
|
|
|
|
|
+Link: [grafana-build-container](https://github.com/grafana/grafana-build-container)
|
|
|
|
|
+
|
|
|
|
|
+#### Dependencies
|
|
|
|
|
+
|
|
|
|
|
+- fpm
|
|
|
|
|
+- nodejs
|
|
|
|
|
+- golang
|
|
|
|
|
+- crosscompiling (several compilers)
|
|
|
|
|
+
|
|
|
|
|
+### Appveyor
|
|
|
|
|
+
|
|
|
|
|
+Master and release builds trigger test runs on Appveyors build environment so that tests will run on Windows.
|
|
|
|
|
+
|
|
|
|
|
+#### Files:
|
|
|
|
|
+
|
|
|
|
|
+- `appveyor.yml`
|
|
|
|
|
+
|
|
|
|
|
+#### Dependencies
|
|
|
|
|
+
|
|
|
|
|
+- nodejs
|
|
|
|
|
+- golang
|
|
|
|
|
+
|
|
|
|
|
+### Dockerfile
|
|
|
|
|
+
|
|
|
|
|
+There is a Docker build for Grafana in the root of the project that allows anyone to build Grafana just using Docker.
|
|
|
|
|
+
|
|
|
|
|
+#### Files
|
|
|
|
|
+
|
|
|
|
|
+- `Dockerfile`
|
|
|
|
|
+
|
|
|
|
|
+#### Dependencies
|
|
|
|
|
+
|
|
|
|
|
+- nodejs
|
|
|
|
|
+- golang
|
|
|
|
|
+
|
|
|
|
|
+### Local developer environments
|
|
|
|
|
+
|
|
|
|
|
+Please send out a notice in the grafana-dev slack channel when updating Go or Node.js to make it easier for everyone to update their local developer environments.
|