IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-12-01 04:59:15 -06:00
Code Issues Packages Projects Releases Wiki Activity
2aaaa98eee
grafana/packages
History
Dominik Prokop 2aaaa98eee
grafana/toolkit: Improve contribution readme (#19400) 
* Improve toolkit's readme about contributing

* Update packages/grafana-toolkit/README.md

Co-Authored-By: kay delaney <45561153+kaydelaney@users.noreply.github.com>
2019-09-25 16:23:59 +02:00
..
grafana-data PanelData: Adds timeRange prop to PanelData (#19361) 2019-09-25 11:19:17 +02:00
grafana-runtime Chore: Bump typescript to version 3.6.3 (#19308) 2019-09-24 10:40:16 +01:00
grafana-toolkit grafana/toolkit: Improve contribution readme (#19400) 2019-09-25 16:23:59 +02:00
grafana-ui DataLinks: suggestions menu improvements (#19396) 2019-09-25 12:46:37 +02:00
README.md Packages: update versioning and release process (#18195) 2019-09-12 08:00:31 +02:00
tsconfig.json Packages: create shared tsconfig.json (#18010) 2019-07-10 12:50:52 +02:00

README.md

Grafana frontend packages

Versioning

We use Lerna for packages versioning and releases

All packages are versioned according to the current Grafana version:

  • Grafana v6.3.0-alpha1 -> @grafana/* packages @ 6.3.0-alpha.1
  • Grafana v6.2.5 -> @grafana/* packages @ 6.2.5
  • Grafana - master branch version (based on package.json, i.e. 6.4.0-pre) -> @grafana/* packages @ 6.4.0-pre- (see details below about packages publishing channels)

Please note that @grafana/toolkit, @grafana/ui, @grafana/data & @grafana/runtime packages are considered ALPHA even though they are not released as alpha versions

Stable releases

Even though packages are released under a stable version, they are considered ALPHA until further notice!

Stable releases are published under latest tag on npm.

Alpha and beta releases

Alpha and beta releases are published under next tag on npm.

Automatic pre-releases

Every commit to master that has changes within packages directory is a subject of npm packages release. ALL packages will be released under version from lerna.json file with commit SHA added to it:

<lerna.json version>-<COMMIT_SHA>

Automatic prereleases are published under canary dist tag.

Manual release

All of the steps below should be performed on a release branch, according to Grafana Release Guide

Make sure you are logged in to npm in your terminal and that you are a part of Grafana org on npm

  1. Run yarn packages:prepare script from root directory. This will perform tests on the packages and prompt for version of the packages. The version should be the same as the one being released.
  • Make sure you use semver convention. So, place a dot between prerelease id and prelease number!!! i.e. 6.3.0-alpha.1
  • Make sure you confirm the version bump when prompted!
  1. Commit changes (lerna.json & package.json files) - "Packages version update: <VERSION>"
  2. Run yarn packages:build script that will prepare distribution packages in packages/grafana-*/dist. These directories are going to be published to npm
  3. Depending whether or not it's a prerelease:
  • When releasing a prelease run packages:publishNext to publish new versions.
  • When releasing a stable version run packages:publishLatest to publish new versions.
  1. Push version commit to the release branch

Building individual packages

To build induvidual packages run grafana-toolkit package:build --scope=<ui|toolkit|runtime|data>