IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
cfdea1ee30a1ddbb599f1fcd6ad8af4fc9d2b74c
grafana/packages
History
owensmallwood cfdea1ee30 PublicDashboards: Frontend routing for public dashboards (#48834) 
* add isPublic to dashboard

* refactor routes to use route group and add placeholder method for sharing apii

* add sharing pane and utils for public dashboard config to sharing modal

* Sharing modal now persists data through the api

* moves ShareDashboard endpoint to new file and starts adding tests

* generates mocks. Adds tests for public dashboard feature flag

* Adds ability to pass in array of features to enable for the test

* test to update public flag on dashboard WIP

* Adds mock for SaveDashboardSharingConfig

* Fixes tests. Had to use FakeDashboardService

* Adds React tests for public dashboards toggle

* removes semicolons

* refactors SharePublic component to use hooks

* rename from `share publicly` to `public dashboard config`

* checkpoint. debugging tests. need to verify name changes

* checkpoint. test bugs fixed. need to finish returning proper response codes

* finish renaming. fix test

* Update pkg/api/api.go

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>

* update backend url

* rename internal objects and commands. fix configuration modal labels

* add endpoint for retrieving public dashboard configuration and populate the frontend state from it

* add test for dashboardCanBePublic

* adds backend routes

* copy DashboardPage component into component for public dashboards. WIP

* adds react routes, and doesnt render main nav bar when viewing a public route

* removes extra react route from testing

* updates component name

* Wrap the original dashboard component so we can pass props relevant to public dashboards, turn kiosk mode on/off, etc

* Wraps DashboardPage in PublicDashboardPage component. DashboardPage gets rendered in kiosk mode when public prop is passed.

* removes commented out code from exploratory work

* Makes public dashboard routes require no auth

* extracts helper to own util file to check if were viewing a public page

* Hides panel dropdown when its being viewed publicly

* formatting

* use function from utils file for determining if publicly viewed. If public, hides app notifications, searchwrapper, and commandpalette.

* adds unit tests for util function used to see if page is being viewed publicly

* cant added annotations to panel when being publicly viewed

* removes useless comment

* hides backend and frontend pubdash routes behind feature flag

* consider feature flag when checking url path to see if on public dashboard

* renames function

* still render app notifications when in public view

* Extract pubdash route logic into own file

* fixes failing tests

* Determines path using location locationUtils. This covers the case when grafana is being hosted on a subpath. Updates tests.

* renames pubdash web route to be more understandable

* rename route

* fixes failing test

* fixes failing test. Needed to update pubdash urls

* sets flag on grafana boot config for if viewing public dashboard. Removes hacky check that looks at the url

* fixes failing tests. Uses config to determine if viewing public dashboard

* renders the blue panel timeInfo on public dashboard panel

* Extracts conditional logic for rendering components out into their own functions

* removes publicDashboardView check, and uses dashboard meta instead

* the timeInfo is always displayed on the panel

* After fetch of public dashboard dto, the meta isPublic flag gets set and used to determine if viewing public dashboard for child components. Fixes tests for PanelHeader.

* Fixes failing test. Needed to add isPublic flag to dashboard meta.

Co-authored-by: Jeff Levin <jeff@levinology.com>
Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
2022-06-02 14:57:55 -06:00
..
grafana-data
PublicDashboards: Frontend routing for public dashboards (#48834)
2022-06-02 14:57:55 -06:00
grafana-e2e
Update Monthly patch updates (#49257)
2022-05-20 13:07:07 +01:00
grafana-e2e-selectors
Update Monthly patch updates (#49257)
2022-05-20 13:07:07 +01:00
grafana-runtime
PublicDashboards: Frontend routing for public dashboards (#48834)
2022-06-02 14:57:55 -06:00
grafana-schema
schema: Use latest cuetsy to fix union generation (#50013)
2022-06-01 13:14:55 -04:00
grafana-toolkit
Chore: remove jest-coverage-badges dep from toolkit (#49883)
2022-05-31 15:09:11 +02:00
grafana-ui
Cloudwatch: Dynamic labels autocomplete (#49794)
2022-06-02 10:54:51 +02:00
jaeger-ui-components
Updated test (#50041)
2022-06-02 09:47:02 +01:00
README.md
Add packages:publishTest command (#43696)
2022-01-05 10:53:46 +01:00

README.md

Grafana frontend packages

This document contains information about Grafana frontend package versioning and releases.

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 - main 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, and @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 the latest tag on npm. If there was alpha/beta version released previously, the next tag is updated to stable version.

Alpha and beta releases

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

Automatic prereleases

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

<lerna.json version>-<COMMIT_SHA>

Manual release

All of the steps below must 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 the root directory. This performs tests on the packages and prompts for the 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 prerelease number, i.e. 6.3.0-alpha.1
    • Make sure you confirm the version bump when prompted!

  2. Commit changes (lerna.json and package.json files) - "Packages version update: <VERSION>"

  3. Run yarn packages:build script that prepares distribution packages in packages/grafana-*/dist. These directories are going to be published to npm.

  4. Depending whether or not it's a prerelease:

    • When releasing a prerelease run packages:publishNext to publish new versions.
    • When releasing a stable version run packages:publishLatest to publish new versions.
    • When releasing a test version run packages:publishTest to publish test versions.

  5. Push version commit to the release branch.

Building individual packages

To build individual packages, run:

grafana-toolkit package:build --scope=<ui|toolkit|runtime|data>

Setting up @grafana/* packages for local development

A known issue with @grafana/* packages is that a lot of times we discover problems on canary channel(see versioning overview) when the version was already pushed to npm.

We can easily avoid that by setting up a local packages registry and test the packages before actually publishing to npm.

In this guide you will set up Verdaccio registry locally to fake npm registry. This will enable testing @grafana/* packages without the need for pushing to main.

Setting up local npm registry

From your terminal:

  1. Modify /etc/hosts file and add the following entry: 127.0.0.1 grafana-npm.local
  2. Navigate to devenv/local-npm directory.
  3. Run docker-compose up. This will start your local npm registry, available at http://grafana-npm.local:4873/
  4. Run npm login --registry=http://grafana-npm.local:4873 --scope=@grafana . This will allow you to publish any @grafana/* package into the local registry.
  5. Run npm config set @grafana:registry http://grafana-npm.local:4873. This will config your npm to install @grafana scoped packages from your local registry.

Publishing packages to local npm registry

You need to follow manual packages release procedure. The only difference is you need to run yarn packages:publishDev task in order to publish to you local registry.

From your terminal:

  1. Run yarn packages:prepare.
  2. Commit changes in package.json and lerna.json files
  3. Build packages: yarn packages:build
  4. Run yarn packages:publishDev.
  5. Navigate to http://grafana-npm.local:4873 and verify that version was published

Locally published packages will be published under dev channel, so in your plugin package.json file you can use that channel. For example:

// plugin's package.json

{
  ...
  "@grafana/data": "dev"
}