forked from grafana.jool/grafana-jool
Hosanna Amane
4 years ago
commit
559e74f3e5
7716 changed files with 1137079 additions and 0 deletions
@ -0,0 +1,12 @@ |
|||
|
|||
# Ignore everything |
|||
* |
|||
|
|||
# But not these files: |
|||
!.gitignore |
|||
!*.mod |
|||
!README.md |
|||
!Variables.mk |
|||
!variables.env |
|||
|
|||
*tmp.mod |
|||
@ -0,0 +1,14 @@ |
|||
# Project Development Dependencies. |
|||
|
|||
This is directory which stores Go modules with pinned buildable package that is used within this repository, managed by https://github.com/bwplotka/bingo. |
|||
|
|||
- Run `bingo get` to install all tools having each own module file in this directory. |
|||
- Run `bingo get <tool>` to install <tool> that have own module file in this directory. |
|||
- For Makefile: Make sure to put `include .bingo/Variables.mk` in your Makefile, then use $(<upper case tool name>) variable where <tool> is the .bingo/<tool>.mod. |
|||
- For shell: Run `source .bingo/variables.env` to source all environment variable for each tool. |
|||
- For go: Import `.bingo/variables.go` to for variable names. |
|||
- See https://github.com/bwplotka/bingo or -h on how to add, remove or change binaries dependencies. |
|||
|
|||
## Requirements |
|||
|
|||
- Go 1.14+ |
|||
@ -0,0 +1,31 @@ |
|||
# Auto generated binary variables helper managed by https://github.com/bwplotka/bingo v0.5.1. DO NOT EDIT.
|
|||
# All tools are designed to be build inside $GOBIN.
|
|||
BINGO_DIR := $(dir $(lastword $(MAKEFILE_LIST))) |
|||
GOPATH ?= $(shell go env GOPATH) |
|||
GOBIN ?= $(firstword $(subst :, ,${GOPATH}))/bin |
|||
GO ?= $(shell which go) |
|||
|
|||
# Below generated variables ensure that every time a tool under each variable is invoked, the correct version
|
|||
# will be used; reinstalling only if needed.
|
|||
# For example for drone variable:
|
|||
#
|
|||
# In your main Makefile (for non array binaries):
|
|||
#
|
|||
#include .bingo/Variables.mk # Assuming -dir was set to .bingo .
|
|||
#
|
|||
#command: $(DRONE)
|
|||
# @echo "Running drone"
|
|||
# @$(DRONE) <flags/args..>
|
|||
#
|
|||
DRONE := $(GOBIN)/drone-v1.4.0 |
|||
$(DRONE): $(BINGO_DIR)/drone.mod |
|||
@# Install binary/ries using Go 1.14+ build command. This is using bwplotka/bingo-controlled, separate go module with pinned dependencies. |
|||
@echo "(re)installing $(GOBIN)/drone-v1.4.0" |
|||
@cd $(BINGO_DIR) && $(GO) build -mod=mod -modfile=drone.mod -o=$(GOBIN)/drone-v1.4.0 "github.com/drone/drone-cli/drone" |
|||
|
|||
WIRE := $(GOBIN)/wire-v0.5.0 |
|||
$(WIRE): $(BINGO_DIR)/wire.mod |
|||
@# Install binary/ries using Go 1.14+ build command. This is using bwplotka/bingo-controlled, separate go module with pinned dependencies. |
|||
@echo "(re)installing $(GOBIN)/wire-v0.5.0" |
|||
@cd $(BINGO_DIR) && $(GO) build -mod=mod -modfile=wire.mod -o=$(GOBIN)/wire-v0.5.0 "github.com/google/wire/cmd/wire" |
|||
|
|||
@ -0,0 +1,7 @@ |
|||
module _ // Auto generated by https://github.com/bwplotka/bingo. DO NOT EDIT |
|||
|
|||
go 1.17 |
|||
|
|||
replace github.com/docker/docker => github.com/docker/engine v17.12.0-ce-rc1.0.20200309214505-aa6a9891b09c+incompatible |
|||
|
|||
require github.com/drone/drone-cli v1.4.0 // drone |
|||
@ -0,0 +1 @@ |
|||
module _ // Fake go.mod auto-created by 'bingo' for go -moddir compatibility with non-Go projects. Commit this file, together with other .mod files. |
|||
@ -0,0 +1,14 @@ |
|||
# Auto generated binary variables helper managed by https://github.com/bwplotka/bingo v0.5.1. DO NOT EDIT. |
|||
# All tools are designed to be build inside $GOBIN. |
|||
# Those variables will work only until 'bingo get' was invoked, or if tools were installed via Makefile's Variables.mk. |
|||
GOBIN=${GOBIN:=$(go env GOBIN)} |
|||
|
|||
if [ -z "$GOBIN" ]; then |
|||
GOBIN="$(go env GOPATH)/bin" |
|||
fi |
|||
|
|||
|
|||
DRONE="${GOBIN}/drone-v1.4.0" |
|||
|
|||
WIRE="${GOBIN}/wire-v0.5.0" |
|||
|
|||
@ -0,0 +1,5 @@ |
|||
module _ // Auto generated by https://github.com/bwplotka/bingo. DO NOT EDIT |
|||
|
|||
go 1.16 |
|||
|
|||
require github.com/google/wire v0.5.0 // cmd/wire |
|||
@ -0,0 +1,22 @@ |
|||
[run] |
|||
init_cmds = [ |
|||
["make", "gen-go"], |
|||
["go", "run", "build.go", "-dev", "build-cli"], |
|||
["go", "run", "build.go", "-dev", "build-server"], |
|||
["./bin/grafana-server", "-packaging=dev", "cfg:app_mode=development"] |
|||
] |
|||
watch_all = true |
|||
follow_symlinks = true |
|||
watch_dirs = [ |
|||
"$WORKDIR/pkg", |
|||
"$WORKDIR/public/views", |
|||
"$WORKDIR/conf", |
|||
] |
|||
watch_exts = [".go", ".ini", ".toml", ".template.html"] |
|||
ignore_files = ["wire_gen.go"] |
|||
build_delay = 1500 |
|||
cmds = [ |
|||
["make", "gen-go"], |
|||
["go", "run", "build.go", "-dev", "build-server"], |
|||
["./bin/grafana-server", "-packaging=dev", "cfg:app_mode=development"] |
|||
] |
|||
@ -0,0 +1,15 @@ |
|||
[dev] |
|||
last 1 chrome versions |
|||
last 1 firefox versions |
|||
last 1 safari versions |
|||
|
|||
[production] |
|||
last 2 Firefox versions |
|||
last 2 Chrome versions |
|||
last 2 Safari versions |
|||
last 2 Edge versions |
|||
last 1 ios_saf versions |
|||
last 1 and_chr versions |
|||
last 1 samsung versions |
|||
|
|||
|
|||
@ -0,0 +1,11 @@ |
|||
version: 2.1 |
|||
jobs: |
|||
build: |
|||
docker: |
|||
- image: alpine:3.7 |
|||
steps: |
|||
- run: |
|||
name: The First Step |
|||
command: | |
|||
echo 'Fake step!' |
|||
|
|||
@ -0,0 +1,25 @@ |
|||
.awcache |
|||
.dockerignore |
|||
.git |
|||
.gitignore |
|||
.github |
|||
.vscode |
|||
bin |
|||
data* |
|||
dist |
|||
docker |
|||
Dockerfile |
|||
docs |
|||
dump.rdb |
|||
node_modules |
|||
**/node_modules |
|||
/tmp |
|||
*.yml |
|||
!.yarnrc.yml |
|||
*.md |
|||
.yarn/* |
|||
!.yarn/patches |
|||
!.yarn/releases |
|||
!.yarn/plugins |
|||
!.yarn/versions |
|||
!.yarn/cache |
|||
@ -0,0 +1,17 @@ |
|||
# To generate the .drone.yml file: |
|||
# 1. Modify the *.star definitions |
|||
# 2. Login to drone and export the env variables (token and server) shown here: https://drone.grafana.net/account |
|||
# 3. Run `make drone` |
|||
# More information about this process here: https://github.com/grafana/deployment_tools/blob/master/docs/infrastructure/drone/signing.md |
|||
|
|||
load('scripts/drone/pipelines/pr.star', 'pr_pipelines') |
|||
load('scripts/drone/pipelines/main.star', 'main_pipelines') |
|||
load('scripts/drone/pipelines/release.star', 'release_pipelines', 'test_release_pipelines') |
|||
load('scripts/drone/version.star', 'version_branch_pipelines') |
|||
load('scripts/drone/pipelines/cron.star', 'cronjobs') |
|||
load('scripts/drone/vault.star', 'secrets') |
|||
|
|||
def main(ctx): |
|||
edition = 'oss' |
|||
return pr_pipelines(edition=edition) + main_pipelines(edition=edition) + release_pipelines() + \ |
|||
test_release_pipelines() + version_branch_pipelines() + cronjobs(edition=edition) + secrets() |
|||
File diff suppressed because it is too large
@ -0,0 +1,30 @@ |
|||
# http://editorconfig.org |
|||
root = true |
|||
|
|||
[*] |
|||
indent_style = space |
|||
indent_size = 2 |
|||
charset = utf-8 |
|||
trim_trailing_whitespace = true |
|||
insert_final_newline = true |
|||
max_line_length = 120 |
|||
|
|||
[*.go] |
|||
indent_style = tab |
|||
indent_size = 4 |
|||
charset = utf-8 |
|||
trim_trailing_whitespace = true |
|||
insert_final_newline = true |
|||
|
|||
[*.{js,ts,tsx,scss}] |
|||
quote_type = single |
|||
|
|||
[*.md] |
|||
trim_trailing_whitespace = false |
|||
|
|||
[Makefile] |
|||
indent_style = tab |
|||
indent_size = 2 |
|||
|
|||
[*.star] |
|||
indent_size = 4 |
|||
@ -0,0 +1,14 @@ |
|||
node_modules |
|||
compiled |
|||
build |
|||
vendor |
|||
devenv |
|||
data |
|||
dist |
|||
e2e/tmp |
|||
public/lib/monaco |
|||
deployment_tools_config.json |
|||
|
|||
# Auto-generated localisation files |
|||
public/locales/_build/ |
|||
public/locales/**/*.js |
|||
@ -0,0 +1,28 @@ |
|||
{ |
|||
"extends": ["@grafana/eslint-config"], |
|||
"root": true, |
|||
"plugins": ["no-only-tests", "@emotion", "lodash"], |
|||
"rules": { |
|||
"no-only-tests/no-only-tests": "error", |
|||
"react/prop-types": "off", |
|||
"@emotion/jsx-import": "error", |
|||
"lodash/import-scope": [2, "member"] |
|||
}, |
|||
"overrides": [ |
|||
{ |
|||
"files": ["packages/grafana-ui/src/components/uPlot/**/*.{ts,tsx}"], |
|||
"rules": { |
|||
"react-hooks/rules-of-hooks": "off", |
|||
"react-hooks/exhaustive-deps": "off" |
|||
} |
|||
}, |
|||
{ |
|||
"files": ["packages/grafana-ui/src/components/ThemeDemos/**/*.{ts,tsx}"], |
|||
"rules": { |
|||
"@emotion/jsx-import": "off", |
|||
"react/jsx-uses-react": "off", |
|||
"react/react-in-jsx-scope": "off" |
|||
} |
|||
} |
|||
] |
|||
} |
|||
@ -0,0 +1 @@ |
|||
* text=auto eol=lf |
|||
@ -0,0 +1,150 @@ |
|||
# Lines starting with '#' are comments. |
|||
# Each line is a file pattern followed by one or more owners. |
|||
|
|||
# More details are here: https://help.github.com/articles/about-codeowners/ |
|||
|
|||
# The '*' pattern is global owners. |
|||
|
|||
# Order is important. The last matching pattern has the most precedence. |
|||
# The folders are ordered as follows: |
|||
|
|||
# In each subsection folders are ordered first by depth, then alphabetically. |
|||
# This should make it easy to add new rules without breaking existing ones. |
|||
|
|||
# Documentation owner: Jita Chatterjee |
|||
/docs/ @grafana/docs-squad @pkolyvas |
|||
/contribute/ @marcusolsson @grafana/docs-squad @pkolyvas |
|||
/docs/sources/developers/plugins/ @marcusolsson @grafana/docs-squad @grafana/plugins-platform-frontend @grafana/plugins-platform-backend |
|||
/docs/sources/developers/plugins/backend @marcusolsson @grafana/docs-squad @grafana/plugins-platform-backend |
|||
/docs/sources/enterprise/ @osg-grafana @grafana/docs-squad |
|||
|
|||
# Backend code |
|||
*.go @grafana/backend-platform |
|||
go.mod @grafana/backend-platform |
|||
go.sum @grafana/backend-platform |
|||
/.bingo @grafana/backend-platform |
|||
|
|||
# Continuous Integration |
|||
.drone.yml @grafana/grafana-release-eng |
|||
.drone.star @grafana/grafana-release-eng |
|||
/scripts/drone/ @grafana/grafana-release-eng |
|||
|
|||
# Cloud Datasources backend code |
|||
/pkg/tsdb/cloudwatch @grafana/cloud-datasources @grafana/observability-squad |
|||
/pkg/tsdb/azuremonitor @grafana/cloud-datasources |
|||
/pkg/tsdb/cloudmonitoring @grafana/cloud-datasources |
|||
|
|||
# Observability backend code |
|||
/pkg/tsdb/influxdb @grafana/observability-squad |
|||
/pkg/tsdb/elasticsearch @grafana/observability-squad |
|||
/pkg/tsdb/graphite @grafana/observability-squad |
|||
/pkg/tsdb/jaeger @grafana/observability-squad |
|||
/pkg/tsdb/loki @grafana/observability-squad |
|||
/pkg/tsdb/zipkin @grafana/observability-squad |
|||
/pkg/tsdb/tempo @grafana/observability-squad |
|||
|
|||
# Database migrations |
|||
/pkg/services/sqlstore/migrations @grafana/backend-platform @grafana/hosted-grafana-team |
|||
*_mig.go @grafana/backend-platform @grafana/hosted-grafana-team |
|||
|
|||
# Grafana live |
|||
/pkg/services/live/ @grafana/grafana-edge-squad |
|||
|
|||
# Unified Alerting |
|||
/pkg/services/ngalert @grafana/alerting-squad |
|||
/pkg/services/sqlstore/migrations/ualert @grafana/alerting-squad |
|||
|
|||
# Library Services |
|||
/pkg/services/libraryelements @grafana/user-essentials |
|||
/pkg/services/librarypanels @grafana/user-essentials |
|||
|
|||
# Plugins |
|||
/pkg/api/pluginproxy @grafana/plugins-platform-backend |
|||
/pkg/plugins @grafana/plugins-platform-backend |
|||
/pkg/services/datasourceproxy @grafana/plugins-platform-backend |
|||
/pkg/services/datasources @grafana/plugins-platform-backend |
|||
|
|||
# Dashboard previews / crawler (behind feature flag) |
|||
/pkg/services/thumbs @grafana/grafana-edge-squad |
|||
|
|||
# Backend code docs |
|||
/contribute/style-guides/backend.md @grafana/backend-platform |
|||
/contribute/architecture/backend @grafana/backend-platform |
|||
/contribute/engineering/backend @grafana/backend-platform |
|||
|
|||
/e2e @grafana/user-essentials |
|||
/packages @grafana/user-essentials @grafana/plugins-platform-frontend @grafana/grafana-bi-squad |
|||
/packages/grafana-e2e-selectors @grafana/user-essentials |
|||
/packages/grafana-e2e @grafana/user-essentials |
|||
/packages/grafana-toolkit @grafana/plugins-platform-frontend |
|||
/packages/grafana-ui/.storybook @grafana/plugins-platform-frontend |
|||
/packages/grafana-ui/src/components/DateTimePickers @grafana/grafana-bi-squad |
|||
/packages/grafana-ui/src/components/GraphNG @grafana/grafana-bi-squad |
|||
/packages/grafana-ui/src/components/Table @grafana/grafana-bi-squad |
|||
/packages/grafana-ui/src/components/TimeSeries @grafana/grafana-bi-squad |
|||
/packages/grafana-ui/src/components/uPlot @grafana/grafana-bi-squad |
|||
/packages/grafana-ui/src/utils/storybook @grafana/plugins-platform-frontend |
|||
/packages/jaeger-ui-components/ @grafana/observability-squad |
|||
/plugins-bundled @grafana/plugins-platform-frontend |
|||
# public folder |
|||
/public/app/core/components/TimePicker @grafana/grafana-bi-squad |
|||
/public/app/core/components/Layers @grafana/grafana-edge-squad |
|||
/public/app/features/canvas/ @grafana/grafana-edge-squad |
|||
/public/app/features/dimensions/ @grafana/grafana-edge-squad |
|||
/public/app/features/live/ @grafana/grafana-edge-squad |
|||
/public/app/features/explore/ @grafana/observability-squad |
|||
/public/app/features/plugins @grafana/plugins-platform-frontend |
|||
/public/app/plugins/panel/alertlist @grafana/alerting-squad |
|||
/public/app/plugins/panel/barchart @grafana/grafana-bi-squad |
|||
/public/app/plugins/panel/heatmap @grafana/grafana-bi-squad |
|||
/public/app/plugins/panel/histogram @grafana/grafana-bi-squad |
|||
/public/app/plugins/panel/nodeGraph @grafana/observability-squad |
|||
/public/app/plugins/panel/piechart @grafana/grafana-bi-squad |
|||
/public/app/plugins/panel/state-timeline @grafana/grafana-bi-squad |
|||
/public/app/plugins/panel/status-history @grafana/grafana-bi-squad |
|||
/public/app/plugins/panel/table @grafana/grafana-bi-squad |
|||
/public/app/plugins/panel/timeseries @grafana/grafana-bi-squad |
|||
/public/app/plugins/panel/geomap @grafana/grafana-edge-squad |
|||
/public/app/plugins/panel/canvas @grafana/grafana-edge-squad |
|||
/public/app/plugins/panel/candlestick @grafana/grafana-edge-squad |
|||
/public/app/plugins/panel/icon @grafana/grafana-edge-squad |
|||
/scripts/build/release-packages.sh @grafana/plugins-platform-frontend |
|||
/scripts/circle-release-next-packages.sh @grafana/plugins-platform-frontend |
|||
/scripts/ci-frontend-metrics.sh @grafana/user-essentials @grafana/plugins-platform-frontend @grafana/grafana-bi-squad |
|||
/scripts/ci-reference-docs-build.sh @grafana/plugins-platform-frontend |
|||
/scripts/ci-reference-docs-lint.sh @grafana/plugins-platform-frontend |
|||
/scripts/grunt @grafana/frontend-ops |
|||
/scripts/webpack @grafana/frontend-ops |
|||
/scripts/generate-a11y-report.sh @grafana/user-essentials |
|||
package.json @grafana/frontend-ops |
|||
tsconfig.json @grafana/frontend-ops |
|||
lerna.json @grafana/frontend-ops |
|||
.babelrc @grafana/frontend-ops |
|||
.prettierrc.js @grafana/frontend-ops |
|||
.eslintrc @grafana/frontend-ops |
|||
.pa11yci.conf.js @grafana/user-essentials |
|||
.pa11yci-pr.conf.js @grafana/user-essentials |
|||
|
|||
# @grafana/ui component documentation |
|||
*.mdx @marcusolsson @jessover9000 @grafana/plugins-platform-frontend |
|||
|
|||
# Core datasources |
|||
/public/app/plugins/datasource/cloudwatch @grafana/cloud-datasources @grafana/observability-squad |
|||
/public/app/plugins/datasource/elasticsearch @grafana/observability-squad |
|||
/public/app/plugins/datasource/grafana-azure-monitor-datasource @grafana/cloud-datasources |
|||
/public/app/plugins/datasource/graphite @grafana/observability-squad |
|||
/public/app/plugins/datasource/influxdb @grafana/observability-squad |
|||
/public/app/plugins/datasource/jaeger @grafana/observability-squad |
|||
/public/app/plugins/datasource/loki @grafana/observability-squad |
|||
/public/app/plugins/datasource/mssql @grafana/backend-platform |
|||
/public/app/plugins/datasource/mysql @grafana/backend-platform |
|||
/public/app/plugins/datasource/opentsdb @grafana/backend-platform |
|||
/public/app/plugins/datasource/postgres @grafana/backend-platform |
|||
/public/app/plugins/datasource/prometheus @grafana/observability-squad |
|||
/public/app/plugins/datasource/cloud-monitoring @grafana/cloud-datasources |
|||
/public/app/plugins/datasource/zipkin @grafana/observability-squad |
|||
/public/app/plugins/datasource/tempo @grafana/observability-squad |
|||
/public/app/plugins/datasource/alertmanager @grafana/alerting-squad |
|||
|
|||
# Cloud middleware |
|||
/grafana-mixin/ @grafana/hosted-grafana-team |
|||
@ -0,0 +1,31 @@ |
|||
--- |
|||
name: Bug report |
|||
about: Report a bug you found when using Grafana |
|||
labels: 'type: bug' |
|||
--- |
|||
|
|||
<!-- |
|||
Please use this template to create your bug report. By providing as much info as possible you help us understand the issue, reproduce it and resolve it for you quicker. Therefore take a couple of extra minutes to make sure you have provided all info needed. |
|||
|
|||
PROTIP: record your screen and attach it as a gif to showcase the issue. |
|||
|
|||
- Questions should be posted to: https://community.grafana.com |
|||
- Use query inspector to troubleshoot issues: https://bit.ly/2XNF6YS |
|||
- How to record and attach gif: https://bit.ly/2Mi8T6K |
|||
--> |
|||
|
|||
**What happened**: |
|||
|
|||
**What you expected to happen**: |
|||
|
|||
**How to reproduce it (as minimally and precisely as possible)**: |
|||
|
|||
**Anything else we need to know?**: |
|||
|
|||
**Environment**: |
|||
- Grafana version: |
|||
- Data source type & version: |
|||
- OS Grafana is installed on: |
|||
- User OS & Browser: |
|||
- Grafana plugins: |
|||
- Others: |
|||
@ -0,0 +1,26 @@ |
|||
--- |
|||
name: Accessibility issue |
|||
about: Help make Grafana be better at keyboard navigation, screen-readable and accessible to all. |
|||
labels: 'type: accessibility' |
|||
--- |
|||
|
|||
<!-- |
|||
Please only use this template for submitting accessibility issues. |
|||
|
|||
This is a new feature area for Grafana that we want to improve. We have long way to go |
|||
to really improve accessibility and would like your help to know where to start. |
|||
--> |
|||
|
|||
**Steps to reproduce**: |
|||
|
|||
**Actual Result**: |
|||
|
|||
**Expected Result** |
|||
|
|||
**Relevant WCAG Criteria:** [#.#.# WCAG Criterion](link to https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0) |
|||
|
|||
**Environment**: |
|||
- Grafana version: |
|||
- Data source type & version: |
|||
- User OS & Browser: |
|||
- Others: |
|||
@ -0,0 +1,39 @@ |
|||
--- |
|||
name: '@grafana/ui component request' |
|||
about: Suggest a component for the @grafana/ui package |
|||
labels: 'area/grafana/ui' |
|||
--- |
|||
|
|||
<!-- |
|||
By using this template you will make it easier for us to make sure that documentation and implementation stays up to date for every component in @grafana/ui |
|||
|
|||
Thank you! |
|||
--> |
|||
|
|||
**Why is this component needed**: |
|||
<!-- Explain your use case --> |
|||
___ |
|||
- [ ] Is/could it be used in more than one place in Grafana? |
|||
|
|||
**Where is/could it be used?**: |
|||
|
|||
___ |
|||
- [ ] Post screenshots possible. |
|||
- [ ] It has a single use case. |
|||
- [ ] It is/could be used in multiple places. |
|||
|
|||
**Implementation** (Checklist meant for the person implementing the component) |
|||
|
|||
- [ ] Component has a story in Storybook. |
|||
- [ ] Props and naming follows [our style guide](https://github.com/grafana/grafana/blob/main/contribute/style-guides/frontend.md). |
|||
- [ ] It is extendable (rest props are spread, styles with className work, and so on). |
|||
- [ ] Uses [theme for spacing, colors, and so on](https://github.com/grafana/grafana/blob/main/contribute/style-guides/themes.md). |
|||
- [ ] Works with both light and dark theme. |
|||
|
|||
**Documentation** |
|||
|
|||
- [ ] Properties are documented. |
|||
- [ ] Use cases are described. |
|||
- [ ] Code examples for the different use cases. |
|||
- [ ] Dos and don'ts. |
|||
- [ ] Styling guidelines, specific color usage (if applicable). |
|||
@ -0,0 +1,8 @@ |
|||
blank_issues_enabled: false |
|||
contact_links: |
|||
- name: Feature Request |
|||
url: https://github.com/grafana/grafana/discussions/new |
|||
about: Discuss ideas for new features of changes |
|||
- name: Questions & Help |
|||
url: https://community.grafana.com |
|||
about: Please ask and answer questions here. |
|||
@ -0,0 +1,34 @@ |
|||
<!-- |
|||
|
|||
Thank you for sending a pull request! Here are some tips: |
|||
|
|||
1. If this is your first time, please read our contribution guide at https://github.com/grafana/grafana/blob/main/CONTRIBUTING.md |
|||
|
|||
2. Ensure you include and run the appropriate tests as part of your Pull Request. |
|||
|
|||
3. In a new feature or configuration option, an update to the documentation is necessary. Everything related to the documentation is under the docs folder in the root of the repository. |
|||
|
|||
4. If the Pull Request is a work in progress, make use of GitHub's "Draft PR" feature and mark it as such. |
|||
|
|||
5. If you can not merge your Pull Request due to a merge conflict, Rebase it. This gets it in sync with the main branch. |
|||
|
|||
6. Name your PR as "<FeatureArea>: Describe your change", e.g. Alerting: Prevent race condition. If it's a fix or feature relevant for the changelog describe the user impact in the title. The PR title is used to auto-generate the changelog for issues marked with the "add to changelog" label. |
|||
|
|||
--> |
|||
|
|||
**What this PR does / why we need it**: |
|||
|
|||
**Which issue(s) this PR fixes**: |
|||
|
|||
<!-- |
|||
|
|||
- Automatically closes linked issue when the Pull Request is merged. |
|||
|
|||
Usage: "Fixes #<issue number>", or "Fixes (paste link of issue)" |
|||
|
|||
--> |
|||
|
|||
Fixes # |
|||
|
|||
**Special notes for your reviewer**: |
|||
|
|||
@ -0,0 +1,30 @@ |
|||
# GitHub & grafanabot automation |
|||
|
|||
The bot is configured via [commands.json](https://github.com/grafana/grafana/blob/main/.github/commands.json) and some other GitHub workflows [workflows](https://github.com/grafana/grafana/tree/main/.github/workflows). |
|||
|
|||
Comment commands: |
|||
|
|||
* Write the word `/duplicate #<number>` anywhere in a comment and the bot will add the correct label and standard message. |
|||
* Write the word `/needsMoreInfo` anywhere in a comment and the bot will add the correct label and standard message. |
|||
|
|||
Label commands: |
|||
|
|||
* Add label `bot/question` the the bot will close with standard question message and add label `type/question` |
|||
* Add label `bot/duplicate` the the bot will close with standard duplicate message and add label `type/duplicate` |
|||
* Add label `bot/needs more info` for bot to request more info (or use comment command mentioned above) |
|||
* Add label `bot/close feature request` for bot to close a feature request with standard message and adds label `not implemented` |
|||
* Add label `bot/no new info` for bot to close an issue where we asked for more info but has not received any updates in at least 14 days. |
|||
|
|||
## Metrics |
|||
|
|||
Metrics are configured in [metrics-collector.json](https://github.com/grafana/grafana/blob/main/.github/metrics-collector.json) and are also defined in the |
|||
[metrics-collector](https://github.com/grafana/grafana-github-actions/blob/main/metrics-collector/index.ts) GitHub action. |
|||
|
|||
## Backport PR |
|||
|
|||
To automatically backport a PR to a release branch like v7.3.x add a label named `backport v7.3.x`. The label name should follow the pattern `backport <branch-name>`. Once merged grafanabot will automatically |
|||
try to cherry-pick the PR merge commit into that branch and open a PR. It will sync the milestone with the source PR so make sure the source PR also is assigned the milestone for the patch release. If the PR is already merged you can still add this label and trigger the backport automation. |
|||
|
|||
If there are merge conflicts the bot will write a comment on the source PR saying the cherry-pick failed. In this case you have to do the cherry pick and backport PR manually. |
|||
|
|||
The backport logic is written [here](https://github.com/grafana/grafana-github-actions/blob/main/backport/backport.ts) |
|||
@ -0,0 +1,181 @@ |
|||
[ |
|||
{ |
|||
"type":"label", |
|||
"name":"bot/question", |
|||
"addLabel":"type/question", |
|||
"removeLabel":"bot/question", |
|||
"action":"close", |
|||
"comment":"Please ask your question on [community.grafana.com/](https://community.grafana.com/). To avoid having your issue closed in the future, please read our [CONTRIBUTING](https://github.com/grafana/grafana/blob/main/CONTRIBUTING.md) guidelines.\n\nHappy graphing!" |
|||
}, |
|||
{ |
|||
"type":"comment", |
|||
"name":"duplicate", |
|||
"allowUsers":[], |
|||
"action":"updateLabels", |
|||
"addLabel":"type/duplicate" |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"bot/duplicate", |
|||
"addLabel":"type/duplicate", |
|||
"removeLabel":"bot/duplicate", |
|||
"action":"close", |
|||
"comment":"Thanks for creating this issue! It looks like this has already been reported by another user. We’ve closed this in favor of the existing one. Please consider adding any details you think is missing to that issue.\n\nTo avoid having your issue closed in the future, please read our [CONTRIBUTING](https://github.com/grafana/grafana/blob/main/CONTRIBUTING.md) guidelines.\n\nHappy graphing!" |
|||
}, |
|||
{ |
|||
"type":"comment", |
|||
"name":"needsMoreInfo", |
|||
"allowUsers":[], |
|||
"action":"updateLabels", |
|||
"addLabel":"bot/needs more info" |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"bot/needs more info", |
|||
"action":"updateLabels", |
|||
"addLabel":"needs more info", |
|||
"removeLabel":"bot/needs more info", |
|||
"comment":"Thanks for creating this issue! We think it's missing some basic information. \r\n\r\nFollow the issue template and add additional information that will help us replicate the problem. \r\nFor data visualization issues: \r\n- Query results from the inspect drawer (data tab & query inspector)\r\n- Panel settings can be extracted in the panel inspect drawer JSON tab\r\n\r\nFor dashboard related issues: \r\n- Dashboard JSON can be found in the dashboard settings JSON model view\r\n\r\nFor authentication, provisioning and alerting issues, Grafana server logs are useful. \r\n\r\nHappy graphing!" |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"bot/no new info", |
|||
"action":"close", |
|||
"comment":"We've closed this issue since it needs more information and hasn't had any activity recently. We can re-open it after you you add more information. To avoid having your issue closed in the future, please read our [CONTRIBUTING](https://github.com/grafana/grafana/blob/main/CONTRIBUTING.md) guidelines.\n\nHappy graphing!" |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"bot/close feature request", |
|||
"action":"close", |
|||
"addLabel":"not implemented", |
|||
"comment":"This feature request has been open for a long time with few received upvotes or comments, so we are closing it. We're trying to limit open GitHub issues in order to better track planned work and features. \r\n\r\nThis doesn't mean that we'll never ever implement it or that we will never accept a PR for it. A closed issue can still attract upvotes and act as a ticket to track feature demand\/interest. \r\n\r\nThank You to you for taking the time to create this issue!" |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"oss-user-essentials", |
|||
"action":"addToProject", |
|||
"addToProject":{ |
|||
"url":"https://github.com/orgs/grafana/projects/78" |
|||
} |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"area/plugins-catalog", |
|||
"action":"addToProject", |
|||
"addToProject":{ |
|||
"url":"https://github.com/orgs/grafana/projects/76" |
|||
} |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"type/docs", |
|||
"action":"addToProject", |
|||
"addToProject":{ |
|||
"url":"https://github.com/orgs/grafana/projects/69" |
|||
} |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"datasource/Azure", |
|||
"action":"addToProject", |
|||
"addToProject":{ |
|||
"url":"https://github.com/orgs/grafana/projects/97" |
|||
} |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"datasource/CloudWatch", |
|||
"action":"addToProject", |
|||
"addToProject":{ |
|||
"url":"https://github.com/orgs/grafana/projects/97" |
|||
} |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"datasource/GoogleCloudMonitoring", |
|||
"action":"addToProject", |
|||
"addToProject":{ |
|||
"url":"https://github.com/orgs/grafana/projects/97" |
|||
} |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"oss-observability", |
|||
"action":"addToProject", |
|||
"addToProject":{ |
|||
"url":"https://github.com/orgs/grafana/projects/54" |
|||
} |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"datasource/Prometheus", |
|||
"action":"addToProject", |
|||
"addToProject":{ |
|||
"url":"https://github.com/orgs/grafana/projects/54" |
|||
} |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"datasource/InfluxDB", |
|||
"action":"addToProject", |
|||
"addToProject":{ |
|||
"url":"https://github.com/orgs/grafana/projects/54" |
|||
} |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"datasource/OpenSearch", |
|||
"action":"addToProject", |
|||
"addToProject":{ |
|||
"url":"https://github.com/orgs/grafana/projects/54" |
|||
} |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"datasource/Loki", |
|||
"action":"addToProject", |
|||
"addToProject":{ |
|||
"url":"https://github.com/orgs/grafana/projects/54" |
|||
} |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"datasource/Tempo", |
|||
"action":"addToProject", |
|||
"addToProject":{ |
|||
"url":"https://github.com/orgs/grafana/projects/54" |
|||
} |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"datasource/Elasticsearch", |
|||
"action":"addToProject", |
|||
"addToProject":{ |
|||
"url":"https://github.com/orgs/grafana/projects/54" |
|||
} |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"area/explore", |
|||
"action":"addToProject", |
|||
"addToProject":{ |
|||
"url":"https://github.com/orgs/grafana/projects/54" |
|||
} |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"oss-user-essentials", |
|||
"action":"removeFromProject", |
|||
"removeFromProject":{ |
|||
"url":"https://github.com/orgs/grafana/projects/78" |
|||
} |
|||
}, |
|||
{ |
|||
"type":"label", |
|||
"name":"oss-user-essentials", |
|||
"action":"removeFromProject", |
|||
"removeFromProject":{ |
|||
"url":"https://github.com/grafana/grafana/projects/33" |
|||
} |
|||
} |
|||
] |
|||
@ -0,0 +1,10 @@ |
|||
version: 2 |
|||
updates: |
|||
- package-ecosystem: "github-actions" |
|||
directory: "/" |
|||
schedule: |
|||
interval: "daily" |
|||
- package-ecosystem: "gomod" |
|||
directory: "/" |
|||
schedule: |
|||
interval: "weekly" |
|||
@ -0,0 +1,32 @@ |
|||
{ |
|||
"queries": [ |
|||
{ |
|||
"name": "type_bug", |
|||
"query": "label:\"type/bug\" is:open" |
|||
}, |
|||
{ |
|||
"name": "type_docs", |
|||
"query": "label:\"type/docs\" is:open" |
|||
}, |
|||
{ |
|||
"name": "needs_investigation", |
|||
"query": "label:\"needs investigation\" is:open" |
|||
}, |
|||
{ |
|||
"name": "needs_more_info", |
|||
"query": "label:\"needs more info\" is:open" |
|||
}, |
|||
{ |
|||
"name": "unlabeled", |
|||
"query": "is:open is:issue no:label" |
|||
}, |
|||
{ |
|||
"name": "open_prs", |
|||
"query": "is:open is:pr" |
|||
}, |
|||
{ |
|||
"name": "milestone_7_4_open", |
|||
"query": "is:open is:issue milestone:7.4" |
|||
} |
|||
] |
|||
} |
|||
@ -0,0 +1,9 @@ |
|||
[ |
|||
{ |
|||
"type": "check-milestone", |
|||
"title": "Milestone Check", |
|||
"targetUrl": "https://github.com/grafana/grafana/blob/main/contribute/merge-pull-request.md#assign-a-milestone", |
|||
"success": "Milestone set", |
|||
"failure": "Milestone not set" |
|||
} |
|||
] |
|||
@ -0,0 +1,190 @@ |
|||
[ |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ |
|||
"docs/**/*", |
|||
"contribute/**/*" |
|||
], |
|||
"action": "updateLabel", |
|||
"addLabel": "type/docs" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ |
|||
"public/**/*", |
|||
"packages/**/*", |
|||
"e2e/**/*", |
|||
"plugins-bundled/**/*", |
|||
"scripts/build/release-packages.sh", |
|||
"scripts/circle-release-next-packages.sh", |
|||
"scripts/ci-frontend-metrics.sh", |
|||
"scripts/grunt/**/*", |
|||
"scripts/webpack/**/*", |
|||
"package.json", |
|||
"tsconfig.json", |
|||
"lerna.json", |
|||
".babelrc", |
|||
".prettierrc.js", |
|||
".eslintrc", |
|||
"**/*.mdx" |
|||
], |
|||
"action": "updateLabel", |
|||
"addLabel": "area/frontend" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ |
|||
"**/*.go", |
|||
"go.mod", |
|||
"go.sum", |
|||
"contribute/style-guides/backend.md", |
|||
"contribute/architecture/backend/**/*", |
|||
"scripts/go/**/*" |
|||
], |
|||
"action": "updateLabel", |
|||
"addLabel": "area/backend" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ |
|||
"pkg/services/sqlstore/migrations/**/*", |
|||
"**/*_mig.go" |
|||
], |
|||
"action": "updateLabel", |
|||
"addLabel": "area/backend/db/migration" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/features/explore/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "area/explore" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ |
|||
".circleci/**/*", |
|||
"packaging/**/*", |
|||
"scripts/build/**/*", |
|||
"scripts/*.sh", |
|||
"Makefile", |
|||
"Dockerfile", |
|||
"Dockerfile.ubuntu" |
|||
], |
|||
"action": "updateLabel", |
|||
"addLabel": "type/build-packaging" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ |
|||
"scripts/*.star", |
|||
".drone.star", |
|||
".drone.yml" |
|||
], |
|||
"action": "updateLabel", |
|||
"addLabel": "type/ci" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/plugins/datasource/grafana-azure-monitor-datasource/**/*", "pkg/tsdb/azuremonitor/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "datasource/Azure" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/plugins/datasource/cloud-monitoring/**/*", "pkg/tsdb/cloudmonitoring/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "datasource/GoogleCloudMonitoring" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/plugins/datasource/cloudwatch/**/*", "pkg/tsdb/cloudwatch/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "datasource/CloudWatch" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/plugins/datasource/elasticsearch/**/*", "pkg/tsdb/elasticsearch/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "datasource/Elasticsearch" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/plugins/datasource/graphite/**/*", "pkg/tsdb/graphite/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "datasource/Graphite" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/plugins/datasource/influxdb/**/*", "pkg/tsdb/influx/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "datasource/InfluxDB" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/plugins/datasource/jaeger"], |
|||
"action": "updateLabel", |
|||
"addLabel": "datasource/Jaeger" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/plugins/datasource/loki/**/*", "pkg/tsdb/loki/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "datasource/Loki" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/plugins/datasource/mssql/**/*", "pkg/tsdb/mssql/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "datasource/MSSQL" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/plugins/datasource/mysql/**/*", "pkg/tsdb/mysql/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "datasource/MySQL" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/plugins/datasource/opentsdb/**/*", "pkg/tsdb/opentsdb/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "datasource/OpenTSDB" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/plugins/datasource/postgres/**/*", "pkg/tsdb/postgres/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "datasource/Postgres" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/plugins/datasource/prometheus/**/*", "pkg/tsdb/prometheus/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "datasource/Prometheus" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/plugins/datasource/tempo/**/*", "pkg/tsdb/tempo/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "datasource/Tempo" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": [ "public/app/plugins/datasource/zipkin/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "datasource/Zipkin" |
|||
}, |
|||
{ |
|||
"type": "changedfiles", |
|||
"matches": ["public/app/features/variables/**/*", "public/app/features/templating/**/*"], |
|||
"action": "updateLabel", |
|||
"addLabel": "area/dashboard/templating" |
|||
}, |
|||
{ |
|||
"type": "author", |
|||
"name": "pr/external", |
|||
"notMemberOf": { "org": "grafana" }, |
|||
"ignoreList": ["renovate[bot]"], |
|||
"action": "updateLabel", |
|||
"addLabel": "pr/external" |
|||
} |
|||
] |
|||
@ -0,0 +1,47 @@ |
|||
{ |
|||
"extends": [ |
|||
"config:base" |
|||
], |
|||
"enabledManagers": ["npm"], |
|||
"ignoreDeps": [ |
|||
"@types/systemjs", |
|||
"@types/d3-force", // we should bump this once we move to esm modules |
|||
"@types/d3-interpolate", // we should bump this once we move to esm modules |
|||
"@types/d3-scale-chromatic", // we should bump this once we move to esm modules |
|||
"@types/react-icons", // jaeger-ui-components is being refactored to use @grafana/ui icons instead |
|||
"d3", |
|||
"d3-force", // we should bump this once we move to esm modules |
|||
"d3-interpolate", // we should bump this once we move to esm modules |
|||
"d3-scale-chromatic", // we should bump this once we move to esm modules |
|||
"eslint", // wait until `eslint-plugin-react-hooks>4.2.0` is released |
|||
"execa", // we should bump this once we move to esm modules |
|||
"history", // we should bump this together with react-router-dom |
|||
"react-icons", // jaeger-ui-components is being refactored to use @grafana/ui icons instead |
|||
"react-router-dom", // we should bump this together with history |
|||
"slate", |
|||
"slate-plain-serializer", |
|||
"systemjs", |
|||
"ts-loader", // we should remove ts-loader and use babel-loader instead |
|||
"ora" // we should bump this once we move to esm modules |
|||
], |
|||
"ignorePaths": ["packages/grafana-toolkit/package.json", "emails/**", "plugins-bundled/**", "**/mocks/**"], |
|||
"labels": ["area/frontend", "dependencies"], |
|||
"packageRules": [ |
|||
{ |
|||
"matchUpdateTypes": ["patch"], |
|||
"extends": ["schedule:monthly"] |
|||
} |
|||
], |
|||
"patch": { |
|||
"enabled": false |
|||
}, |
|||
"pin": { |
|||
"enabled": false |
|||
}, |
|||
"prConcurrentLimit": 10, |
|||
"reviewers": ["team:grafana/frontend-ops"], |
|||
"separateMajorMinor": false, |
|||
"vulnerabilityAlerts": { |
|||
"addLabels": ["area/security"] |
|||
} |
|||
} |
|||
@ -0,0 +1,47 @@ |
|||
# Configuration for probot-stale - https://github.com/probot/stale |
|||
|
|||
# General configuration |
|||
# Label to use when marking as stale |
|||
staleLabel: stale |
|||
|
|||
# Pull request specific configuration |
|||
pulls: |
|||
# Number of days of inactivity before an Issue or Pull Request becomes stale |
|||
daysUntilStale: 14 |
|||
# Number of days of inactivity before a stale Issue or Pull Request is closed. |
|||
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale. |
|||
daysUntilClose: 30 |
|||
# Comment to post when marking as stale. Set to `false` to disable |
|||
markComment: > |
|||
This pull request has been automatically marked as stale because it has not had |
|||
activity in the last 2 weeks. It will be closed in 30 days if no further activity occurs. Please |
|||
feel free to give a status update now, ping for review, or re-open when it's ready. |
|||
Thank you for your contributions! |
|||
# Comment to post when closing a stale Issue or Pull Request. |
|||
closeComment: > |
|||
This pull request has been automatically closed because it has not had |
|||
activity in the last 30 days. Please feel free to give a status update now, ping for review, or re-open when it's ready. |
|||
Thank you for your contributions! |
|||
# Limit the number of actions per hour, from 1-30. Default is 30 |
|||
limitPerRun: 1 |
|||
|
|||
exemptLabels: |
|||
- help wanted |
|||
- type/bug |
|||
- type/feature-request |
|||
- Epic |
|||
- no stalebot |
|||
|
|||
# Issue specific configuration |
|||
issues: |
|||
limitPerRun: 1 |
|||
daysUntilStale: 100000 |
|||
daysUntilClose: 100000 |
|||
markComment: > |
|||
This issue has been automatically marked as stale because it has not had activity in the |
|||
last 100 days. It will be closed in the next 100 days if no activity occurs. |
|||
Thank you for your contributions. |
|||
closeComment: > |
|||
This issue has been automatically closed because it has not had activity in the |
|||
last month and a half. If this issue is still valid, please ping a maintainer and ask them to check this again. |
|||
Thank you for your contributions. |
|||
@ -0,0 +1,26 @@ |
|||
name: Backport PR Creator |
|||
on: |
|||
pull_request_target: |
|||
types: |
|||
- closed |
|||
- labeled |
|||
|
|||
jobs: |
|||
main: |
|||
runs-on: ubuntu-latest |
|||
steps: |
|||
- name: Checkout Actions |
|||
uses: actions/checkout@v2 |
|||
with: |
|||
repository: "grafana/grafana-github-actions" |
|||
path: ./actions |
|||
ref: main |
|||
- name: Install Actions |
|||
run: npm install --production --prefix ./actions |
|||
- name: Run backport |
|||
uses: ./actions/backport |
|||
with: |
|||
metricsWriteAPIKey: ${{secrets.GRAFANA_MISC_STATS_API_KEY}} |
|||
token: ${{secrets.GH_BOT_ACCESS_TOKEN}} |
|||
labelsToAdd: "backport" |
|||
title: "[{{base}}] {{originalTitle}}" |
|||
@ -0,0 +1,98 @@ |
|||
name: Bump version |
|||
on: |
|||
workflow_dispatch: |
|||
inputs: |
|||
version: |
|||
required: true |
|||
default: '7.x.x' |
|||
workflow_call: |
|||
inputs: |
|||
version_call: |
|||
description: Needs to match, exactly, the name of a version |
|||
required: true |
|||
type: string |
|||
secrets: |
|||
token: |
|||
required: true |
|||
metricsWriteAPIKey: |
|||
required: true |
|||
jobs: |
|||
main: |
|||
runs-on: ubuntu-latest |
|||
steps: |
|||
# This is a basic workflow to help you get started with Actions |
|||
- uses: actions-ecosystem/action-regex-match@v2.0.2 |
|||
if: ${{ github.event.inputs.version != '' }} |
|||
id: regex-match |
|||
with: |
|||
text: ${{ github.event.inputs.version }} |
|||
regex: '^(\d+.\d+).\d+(?:-beta.\d+)?$' |
|||
- uses: actions-ecosystem/action-regex-match@v2.0.2 |
|||
if: ${{ inputs.version_call != '' }} |
|||
id: regex-match-version-call |
|||
with: |
|||
text: ${{ inputs.version_call }} |
|||
regex: '^(\d+.\d+).\d+(?:-beta\d+)?$' |
|||
- name: Validate input version |
|||
if: ${{ steps.regex-match.outputs.match == '' && github.event.inputs.version != '' }} |
|||
run: | |
|||
echo "The input version format is not correct, please respect:\ |
|||
major.minor.patch or major.minor.patch-beta.number format. \ |
|||
example: 7.4.3 or 7.4.3-beta.1" |
|||
exit 1 |
|||
- name: Validate input version call |
|||
if: ${{ inputs.version_call != '' && steps.regex-match-version-call.outputs.match == '' }} |
|||
run: | |
|||
echo "The input version format is not correct, please respect:\ |
|||
major.minor.patch or major.minor.patch-beta<number> format. \ |
|||
example: 7.4.3 or 7.4.3-beta1" |
|||
exit 1 |
|||
|
|||
- uses: actions/checkout@v2 |
|||
|
|||
- name: Set intermedia variables |
|||
id: intermedia |
|||
run: | |
|||
echo "::set-output name=short_ref::${GITHUB_REF#refs/*/}" |
|||
echo "::set-output name=check_passed::false" |
|||
echo "::set-output name=branch_name::v${{steps.regex-match.outputs.group1}}" |
|||
echo "::set-output name=branch_exist::$(git ls-remote --heads https://github.com/grafana/grafana.git v${{ steps.regex-match.outputs.group1 }}.x | wc -l)" |
|||
|
|||
- name: Check input version is aligned with branch(not main) |
|||
if: ${{ github.event.inputs.version != '' && steps.intermedia.outputs.branch_exist != '0' && !contains(steps.intermedia.outputs.short_ref, steps.intermedia.outputs.branch_name) }} |
|||
run: | |
|||
echo " You need to run the workflow on branch v${{steps.regex-match.outputs.group1}}.x |
|||
exit 1 |
|||
|
|||
- name: Check input version is aligned with branch(main) |
|||
if: ${{ github.event.inputs.version != '' && steps.intermedia.outputs.branch_exist == '0' && !contains(steps.intermedia.outputs.short_ref, 'main') }} |
|||
run: | |
|||
echo "When you want to deliver a new new minor version, you might want to create a new branch first \ |
|||
with naming convention v[major].[minor].x, and just run the workflow on that branch. \ |
|||
Run the workflow on main only when needed" |
|||
exit 1 |
|||
|
|||
- name: Checkout Actions |
|||
uses: actions/checkout@v2 |
|||
with: |
|||
repository: "grafana/grafana-github-actions" |
|||
path: ./actions |
|||
ref: main |
|||
- uses: actions/setup-node@v2.4.1 |
|||
with: |
|||
node-version: '14' |
|||
- name: Install Actions |
|||
run: npm install --production --prefix ./actions |
|||
- name: Run bump version (manually invoked) |
|||
if: ${{ github.event.inputs.version != '' }} |
|||
uses: ./actions/bump-version |
|||
with: |
|||
token: ${{ secrets.GH_BOT_ACCESS_TOKEN }} |
|||
metricsWriteAPIKey: ${{ secrets.GRAFANA_MISC_STATS_API_KEY }} |
|||
- name: Run bump version (workflow invoked) |
|||
if: ${{ inputs.version_call != '' }} |
|||
uses: ./actions/bump-version |
|||
with: |
|||
version_call: ${{ inputs.version_call }} |
|||
token: ${{ secrets.token }} |
|||
metricsWriteAPIKey: ${{ secrets.metricsWriteAPIKey }} |
|||
@ -0,0 +1,39 @@ |
|||
name: Close milestone |
|||
on: |
|||
workflow_dispatch: |
|||
inputs: |
|||
version: |
|||
required: true |
|||
description: Needs to match, exactly, the name of a milestone |
|||
workflow_call: |
|||
inputs: |
|||
version_call: |
|||
description: Needs to match, exactly, the name of a milestone |
|||
required: true |
|||
type: string |
|||
secrets: |
|||
token: |
|||
required: true |
|||
jobs: |
|||
main: |
|||
runs-on: ubuntu-latest |
|||
steps: |
|||
- name: Checkout Actions |
|||
uses: actions/checkout@v2 |
|||
with: |
|||
repository: "grafana/grafana-github-actions" |
|||
path: ./actions |
|||
ref: main |
|||
- name: Install Actions |
|||
run: npm install --production --prefix ./actions |
|||
- name: Close milestone (manually invoked) |
|||
if: ${{ github.event.inputs.version != '' }} |
|||
uses: ./actions/close-milestone |
|||
with: |
|||
token: ${{ secrets.GH_BOT_ACCESS_TOKEN }} |
|||
- name: Close milestone (workflow invoked) |
|||
if: ${{ inputs.version_call != '' }} |
|||
uses: ./actions/close-milestone |
|||
with: |
|||
version_call: ${{ inputs.version_call }} |
|||
token: ${{ secrets.token }} |
|||
@ -0,0 +1,66 @@ |
|||
# For most projects, this workflow file will not need changing; you simply need |
|||
# to commit it to your repository. |
|||
# |
|||
# You may wish to alter this file to override the set of languages analyzed, |
|||
# or to provide custom queries or build logic. |
|||
name: "CodeQL" |
|||
|
|||
on: |
|||
push: |
|||
branches: [main, v1.8.x, v2.0.x, v2.1.x, v2.6.x, v3.0.x, v3.1.x, v4.0.x, v4.1.x, v4.2.x, v4.3.x, v4.4.x, v4.5.x, v4.6.x, v4.7.x, v5.0.x, v5.1.x, v5.2.x, v5.3.x, v5.4.x, v6.0.x, v6.1.x, v6.2.x, v6.3.x, v6.4.x, v6.5.x, v6.6.x, v6.7.x, v7.0.x, v7.1.x, v7.2.x] |
|||
pull_request: |
|||
# The branches below must be a subset of the branches above |
|||
branches: [main] |
|||
schedule: |
|||
- cron: '0 4 * * 6' |
|||
|
|||
jobs: |
|||
analyze: |
|||
name: Analyze |
|||
runs-on: ubuntu-latest |
|||
|
|||
strategy: |
|||
fail-fast: false |
|||
matrix: |
|||
# Override automatic language detection by changing the below list |
|||
# Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python'] |
|||
language: ['javascript', 'go', 'python'] |
|||
# Learn more... |
|||
# https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection |
|||
|
|||
steps: |
|||
- name: Checkout repository |
|||
uses: actions/checkout@v2 |
|||
with: |
|||
# We must fetch at least the immediate parents so that if this is |
|||
# a pull request then we can checkout the head. |
|||
fetch-depth: 2 |
|||
|
|||
# Initializes the CodeQL tools for scanning. |
|||
- name: Initialize CodeQL |
|||
uses: github/codeql-action/init@v1 |
|||
with: |
|||
languages: ${{ matrix.language }} |
|||
# If you wish to specify custom queries, you can do so here or in a config file. |
|||
# By default, queries listed here will override any specified in a config file. |
|||
# Prefix the list here with "+" to use these queries and those in the config file. |
|||
# queries: ./path/to/local/query, your-org/your-repo/queries@main |
|||
|
|||
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java). |
|||
# If this step fails, then you should remove it and run the build manually (see below) |
|||
- name: Autobuild |
|||
uses: github/codeql-action/autobuild@v1 |
|||
|
|||
# ℹ️ Command-line programs to run using the OS shell. |
|||
# 📚 https://git.io/JvXDl |
|||
|
|||
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines |
|||
# and modify them (or add more) to build your code if your project |
|||
# uses a compiled language |
|||
|
|||
#- run: | |
|||
# make bootstrap |
|||
# make release |
|||
|
|||
- name: Perform CodeQL Analysis |
|||
uses: github/codeql-action/analyze@v1 |
|||
@ -0,0 +1,25 @@ |
|||
name: Run commands when issues are labeled or comments added |
|||
on: |
|||
issues: |
|||
types: [labeled, unlabeled] |
|||
issue_comment: |
|||
types: [created] |
|||
|
|||
jobs: |
|||
main: |
|||
runs-on: ubuntu-latest |
|||
steps: |
|||
- name: Checkout Actions |
|||
uses: actions/checkout@v2 |
|||
with: |
|||
repository: "grafana/grafana-github-actions" |
|||
path: ./actions |
|||
ref: main |
|||
- name: Install Actions |
|||
run: npm install --production --prefix ./actions |
|||
- name: Run Commands |
|||
uses: ./actions/commands |
|||
with: |
|||
metricsWriteAPIKey: ${{secrets.GRAFANA_MISC_STATS_API_KEY}} |
|||
token: ${{secrets.GH_BOT_ACCESS_TOKEN}} |
|||
configPath: commands |
|||
@ -0,0 +1,54 @@ |
|||
name: Levitate / Detect breaking changes |
|||
|
|||
on: pull_request |
|||
|
|||
jobs: |
|||
build: |
|||
name: Detect |
|||
runs-on: ubuntu-latest |
|||
env: |
|||
GITHUB_STEP_NUMBER: 7 |
|||
|
|||
steps: |
|||
- uses: actions/checkout@v2 |
|||
|
|||
- name: Setup environment |
|||
uses: actions/setup-node@v2 |
|||
with: |
|||
node-version: '16' |
|||
|
|||
- name: Get link for the Github Action job |
|||
id: job |
|||
uses: actions/github-script@v5 |
|||
with: |
|||
script: | |
|||
const script = require('./.github/workflows/scripts/pr-get-job-link.js') |
|||
await script({github, context, core}) |
|||
|
|||
- name: Install dependencies |
|||
run: yarn install --immutable |
|||
|
|||
- name: Build packages |
|||
run: yarn packages:build |
|||
|
|||
- name: Detect breaking changes |
|||
id: breaking-changes |
|||
run: ./scripts/check-breaking-changes.sh |
|||
env: |
|||
FORCE_COLOR: 3 |
|||
GITHUB_JOB_LINK: ${{ steps.job.outputs.link }} |
|||
|
|||
- name: Persisting the check output |
|||
run: | |
|||
mkdir -p ./levitate |
|||
echo "{ \"exit_code\": ${{ steps.breaking-changes.outputs.is_breaking }}, \"message\": \"${{ steps.breaking-changes.outputs.message }}\", \"job_link\": \"${{ steps.job.outputs.link }}#step:${GITHUB_STEP_NUMBER}:1\" }" > ./levitate/result.json |
|||
|
|||
- name: Upload check output as artifact |
|||
uses: actions/upload-artifact@v2 |
|||
with: |
|||
name: levitate |
|||
path: levitate/ |
|||
|
|||
- name: Exit |
|||
run: exit ${{ steps.breaking-changes.outputs.is_breaking }} |
|||
shell: bash |
|||
@ -0,0 +1,163 @@ |
|||
name: Levitate / Report breaking changes |
|||
|
|||
on: |
|||
workflow_run: |
|||
workflows: ["Levitate / Detect breaking changes"] |
|||
types: [completed] |
|||
|
|||
jobs: |
|||
notify: |
|||
name: Report |
|||
runs-on: ubuntu-latest |
|||
env: |
|||
ARTIFACT_FOLDER: '${{ github.workspace }}/tmp' |
|||
ARTIFACT_NAME: 'levitate' |
|||
|
|||
steps: |
|||
- uses: actions/checkout@v2 |
|||
|
|||
- name: 'Download artifact' |
|||
uses: actions/github-script@v5 |
|||
env: |
|||
RUN_ID: ${{ github.event.workflow_run.id }} |
|||
with: |
|||
script: | |
|||
const fs = require('fs'); |
|||
|
|||
const { owner, repo } = context.repo; |
|||
const runId = process.env.RUN_ID; |
|||
const artifactName = process.env.ARTIFACT_NAME; |
|||
const artifactFolder = process.env.ARTIFACT_FOLDER; |
|||
const artifacts = await github.rest.actions.listWorkflowRunArtifacts({ |
|||
owner, |
|||
repo, |
|||
run_id: runId, |
|||
}); |
|||
const artifact = artifacts.data.artifacts.find(a => a.name === artifactName); |
|||
|
|||
if (!artifact) { |
|||
throw new Error(`Could not find artifact ${ artifactName } in workflow (${ runId })`); |
|||
} |
|||
|
|||
const download = await github.rest.actions.downloadArtifact({ |
|||
owner, |
|||
repo, |
|||
artifact_id: artifact.id, |
|||
archive_format: 'zip', |
|||
}); |
|||
|
|||
fs.mkdirSync(artifactFolder, { recursive: true }); |
|||
fs.writeFileSync(`${ artifactFolder }/${ artifactName }.zip`, Buffer.from(download.data)); |
|||
|
|||
- name: Unzip artifact |
|||
run: unzip "${ARTIFACT_FOLDER}/${ARTIFACT_NAME}.zip" -d "${ARTIFACT_FOLDER}" |
|||
|
|||
- name: Parsing levitate result |
|||
uses: actions/github-script@v5 |
|||
id: levitate-run |
|||
with: |
|||
script: | |
|||
const filePath = `${ process.env.ARTIFACT_FOLDER }/result.json`; |
|||
const script = require('./.github/workflows/scripts/json-file-to-job-output.js'); |
|||
await script({ core, filePath }); |
|||
|
|||
- name: Check if "breaking change" label exists |
|||
id: does-label-exist |
|||
uses: actions/github-script@v5 |
|||
env: |
|||
PR_NUMBER: ${{ github.event.workflow_run.pull_requests[0].number }} |
|||
with: |
|||
script: | |
|||
const { data } = await github.rest.issues.listLabelsOnIssue({ |
|||
issue_number: process.env.PR_NUMBER, |
|||
owner: context.repo.owner, |
|||
repo: context.repo.repo, |
|||
}); |
|||
const labels = data.map(({ name }) => name); |
|||
const doesExist = labels.includes('breaking change'); |
|||
|
|||
return doesExist ? 1 : 0; |
|||
|
|||
- name: Comment on PR |
|||
if: ${{ steps.levitate-run.outputs.exit_code == 1 }} |
|||
uses: marocchino/sticky-pull-request-comment@v2 |
|||
with: |
|||
number: ${{ github.event.workflow_run.pull_requests[0].number }} |
|||
message: | |
|||
⚠️ **Possible breaking changes** |
|||
|
|||
_(Open the links below in a new tab to go to the correct steps)_ |
|||
|
|||
${{ steps.levitate-run.outputs.message }} |
|||
|
|||
[Check console output](${{ steps.levitate-run.outputs.job_link }}) |
|||
|
|||
- name: Remove comment on PR |
|||
if: ${{ steps.levitate-run.outputs.exit_code == 0 }} |
|||
uses: marocchino/sticky-pull-request-comment@v2 |
|||
with: |
|||
number: ${{ github.event.workflow_run.pull_requests[0].number }} |
|||
delete: true |
|||
|
|||
|
|||
- name: Add "breaking change" label |
|||
if: ${{ steps.levitate-run.outputs.exit_code == 1 && steps.does-label-exist.outputs.result == 0 }} |
|||
uses: actions/github-script@v5 |
|||
env: |
|||
PR_NUMBER: ${{ github.event.workflow_run.pull_requests[0].number }} |
|||
with: |
|||
script: | |
|||
await github.rest.issues.addLabels({ |
|||
issue_number: process.env.PR_NUMBER, |
|||
owner: context.repo.owner, |
|||
repo: context.repo.repo, |
|||
labels: ['breaking change'] |
|||
}) |
|||
|
|||
- name: Remove "breaking change" label |
|||
if: ${{ steps.levitate-run.outputs.exit_code == 0 && steps.does-label-exist.outputs.result == 1 }} |
|||
uses: actions/github-script@v5 |
|||
env: |
|||
PR_NUMBER: ${{ github.event.workflow_run.pull_requests[0].number }} |
|||
with: |
|||
script: | |
|||
await github.rest.issues.removeLabel({ |
|||
issue_number: process.env.PR_NUMBER, |
|||
owner: context.repo.owner, |
|||
repo: context.repo.repo, |
|||
name: 'breaking change' |
|||
}) |
|||
|
|||
# This is very weird, the actual request goes through (comes back with a 201), but does not assign the team. |
|||
# Related issue: https://github.com/renovatebot/renovate/issues/1908 |
|||
- name: Add "grafana/plugins-platform-frontend" as a reviewer |
|||
if: ${{ steps.levitate-run.outputs.exit_code == 1 }} |
|||
uses: actions/github-script@v5 |
|||
env: |
|||
PR_NUMBER: ${{ github.event.workflow_run.pull_requests[0].number }} |
|||
with: |
|||
script: | |
|||
await github.rest.pulls.requestReviewers({ |
|||
pull_number: process.env.PR_NUMBER, |
|||
owner: context.repo.owner, |
|||
repo: context.repo.repo, |
|||
reviewers: [], |
|||
team_reviewers: ['grafana/plugins-platform-frontend'] |
|||
}); |
|||
|
|||
- name: Remove "grafana/plugins-platform-frontend" from the list of reviewers |
|||
if: ${{ steps.levitate-run.outputs.exit_code == 0 }} |
|||
uses: actions/github-script@v5 |
|||
env: |
|||
PR_NUMBER: ${{ github.event.workflow_run.pull_requests[0].number }} |
|||
with: |
|||
script: | |
|||
await github.rest.pulls.removeRequestedReviewers({ |
|||
pull_number: process.env.PR_NUMBER, |
|||
owner: context.repo.owner, |
|||
repo: context.repo.repo, |
|||
reviewers: [], |
|||
team_reviewers: ['grafana/plugins-platform-frontend'] |
|||
}); |
|||
|
|||
|
|||
@ -0,0 +1,24 @@ |
|||
name: Create or update GitHub release |
|||
on: |
|||
workflow_dispatch: |
|||
inputs: |
|||
version: |
|||
required: true |
|||
description: Needs to match, exactly, the name of a milestone (NO v prefix) |
|||
jobs: |
|||
main: |
|||
runs-on: ubuntu-latest |
|||
steps: |
|||
- name: Checkout Actions |
|||
uses: actions/checkout@v2 |
|||
with: |
|||
repository: "grafana/grafana-github-actions" |
|||
path: ./actions |
|||
ref: main |
|||
- name: Install Actions |
|||
run: npm install --production --prefix ./actions |
|||
- name: Run github release action |
|||
uses: ./actions/github-release |
|||
with: |
|||
token: ${{secrets.GH_BOT_ACCESS_TOKEN}} |
|||
metricsWriteAPIKey: ${{secrets.GRAFANA_MISC_STATS_API_KEY}} |
|||
@ -0,0 +1,35 @@ |
|||
# |
|||
# When triggered by the cron job it will also collect metrics for: |
|||
# * number of issues without label |
|||
# * number of issues with "needs more info" |
|||
# * number of issues with "needs investigation" |
|||
# * number of issues with label type/bug |
|||
# * number of open issues in current milestone |
|||
# |
|||
# https://github.com/grafana/grafana-github-actions/blob/main/metrics-collector/index.ts |
|||
# |
|||
name: Github issue metrics collection |
|||
on: |
|||
schedule: |
|||
- cron: "*/10 * * * *" |
|||
issues: |
|||
types: [opened, closed] |
|||
|
|||
jobs: |
|||
main: |
|||
runs-on: ubuntu-latest |
|||
steps: |
|||
- name: Checkout Actions |
|||
uses: actions/checkout@v2 |
|||
with: |
|||
repository: "grafana/grafana-github-actions" |
|||
path: ./actions |
|||
ref: main |
|||
- name: Install Actions |
|||
run: npm install --production --prefix ./actions |
|||
- name: Run metrics collector |
|||
uses: ./actions/metrics-collector |
|||
with: |
|||
metricsWriteAPIKey: ${{secrets.GRAFANA_MISC_STATS_API_KEY}} |
|||
token: ${{secrets.GH_BOT_ACCESS_TOKEN}} |
|||
configPath: "metrics-collector" |
|||
@ -0,0 +1,28 @@ |
|||
name: PR Checks |
|||
on: |
|||
pull_request_target: |
|||
types: |
|||
- opened |
|||
- synchronize |
|||
issues: |
|||
types: |
|||
- milestoned |
|||
- demilestoned |
|||
|
|||
jobs: |
|||
main: |
|||
runs-on: ubuntu-latest |
|||
steps: |
|||
- name: Checkout Actions |
|||
uses: actions/checkout@v2 |
|||
with: |
|||
repository: "grafana/grafana-github-actions" |
|||
path: ./actions |
|||
ref: main |
|||
- name: Install Actions |
|||
run: npm install --production --prefix ./actions |
|||
- name: Run PR Checks |
|||
uses: ./actions/pr-checks |
|||
with: |
|||
token: ${{secrets.GITHUB_TOKEN}} |
|||
configPath: pr-checks |
|||
@ -0,0 +1,17 @@ |
|||
name: Run when PRs are closed |
|||
on: |
|||
pull_request: |
|||
types: |
|||
- closed |
|||
|
|||
jobs: |
|||
close_job: |
|||
# this job will only run if the PR has been closed without being merged |
|||
if: github.event.pull_request.merged == false |
|||
runs-on: ubuntu-latest |
|||
steps: |
|||
- run: | |
|||
echo PR #${{ github.event.number }} has been closed without being merged, removing milestone. |
|||
gh pr edit ${{ github.event.number }} --milestone "" --repo $GITHUB_REPOSITORY |
|||
env: |
|||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
|||
@ -0,0 +1,25 @@ |
|||
name: PR automation |
|||
on: |
|||
pull_request_target: |
|||
types: |
|||
- opened |
|||
- synchronize |
|||
|
|||
jobs: |
|||
main: |
|||
runs-on: ubuntu-latest |
|||
steps: |
|||
- name: Checkout Actions |
|||
uses: actions/checkout@v2 |
|||
with: |
|||
repository: "grafana/grafana-github-actions" |
|||
path: ./actions |
|||
ref: main |
|||
- name: Install Actions |
|||
run: npm install --production --prefix ./actions |
|||
- name: Run Commands |
|||
uses: ./actions/commands |
|||
with: |
|||
metricsWriteAPIKey: ${{secrets.GRAFANA_MISC_STATS_API_KEY}} |
|||
token: ${{secrets.GH_BOT_ACCESS_TOKEN}} |
|||
configPath: pr-commands |
|||
@ -0,0 +1,37 @@ |
|||
name: Prepare release |
|||
on: |
|||
workflow_dispatch: |
|||
inputs: |
|||
version_input: |
|||
description: 'The version to be released please respect: major.minor.patch or major.minor.patch-beta<number> format. example: 7.4.3 or 7.4.3-beta1' |
|||
required: true |
|||
jobs: |
|||
call-remove-milestone: |
|||
uses: grafana/grafana/.github/workflows/remove-milestone.yml@main |
|||
with: |
|||
version_call: ${{ github.event.inputs.version_input }} |
|||
secrets: |
|||
token: ${{ secrets.GH_BOT_ACCESS_TOKEN }} |
|||
call-close-milestone: |
|||
uses: grafana/grafana/.github/workflows/close-milestone.yml@main |
|||
with: |
|||
version_call: ${{ github.event.inputs.version_input }} |
|||
secrets: |
|||
token: ${{ secrets.GH_BOT_ACCESS_TOKEN }} |
|||
needs: call-remove-milestone |
|||
call-bump-version: |
|||
uses: grafana/grafana/.github/workflows/bump-version.yml@main |
|||
with: |
|||
version_call: ${{ github.event.inputs.version_input }} |
|||
secrets: |
|||
token: ${{ secrets.GH_BOT_ACCESS_TOKEN }} |
|||
metricsWriteAPIKey: ${{ secrets.GRAFANA_MISC_STATS_API_KEY }} |
|||
needs: call-close-milestone |
|||
call-update-changelog: |
|||
uses: grafana/grafana/.github/workflows/update-changelog.yml@main |
|||
with: |
|||
version_call: ${{ github.event.inputs.version_input }} |
|||
secrets: |
|||
token: ${{ secrets.GH_BOT_ACCESS_TOKEN }} |
|||
metricsWriteAPIKey: ${{ secrets.GRAFANA_MISC_STATS_API_KEY }} |
|||
needs: call-bump-version |
|||
@ -0,0 +1,49 @@ |
|||
name: publish_docs |
|||
|
|||
on: |
|||
push: |
|||
branches: |
|||
- main |
|||
paths: |
|||
- 'docs/sources/**' |
|||
- 'packages/grafana-*/**' |
|||
|
|||
jobs: |
|||
build: |
|||
|
|||
runs-on: ubuntu-latest |
|||
|
|||
steps: |
|||
- uses: actions/checkout@v1 |
|||
- run: git clone --single-branch --no-tags --depth 1 -b master https://grafanabot:${{ secrets.GH_BOT_ACCESS_TOKEN }}@github.com/grafana/website-sync ./.github/actions/website-sync |
|||
- name: generate-packages-docs |
|||
uses: actions/setup-node@v2.4.1 |
|||
id: generate-docs |
|||
with: |
|||
node-version: '14' |
|||
- name: Get yarn cache directory path |
|||
id: yarn-cache-dir-path |
|||
run: echo "::set-output name=dir::$(yarn config get cacheFolder)" |
|||
- uses: actions/cache@v2.1.6 |
|||
with: |
|||
path: ${{ steps.yarn-cache-dir-path.outputs.dir }} |
|||
key: yarn-${{ hashFiles('**/yarn.lock') }} |
|||
restore-keys: | |
|||
yarn- |
|||
- run: yarn install --immutable |
|||
- run: ./scripts/ci-reference-docs-build.sh |
|||
- name: publish-to-git |
|||
uses: ./.github/actions/website-sync |
|||
id: publish |
|||
with: |
|||
repository: grafana/website |
|||
branch: master |
|||
host: github.com |
|||
github_pat: '${{ secrets.GH_BOT_ACCESS_TOKEN }}' |
|||
source_folder: docs/sources |
|||
target_folder: content/docs/grafana/next |
|||
allow_no_changes: 'true' |
|||
- shell: bash |
|||
run: | |
|||
test -n "${{ steps.publish.outputs.commit_hash }}" |
|||
test -n "${{ steps.publish.outputs.working_directory }}" |
|||
@ -0,0 +1,39 @@ |
|||
name: Remove milestone |
|||
on: |
|||
workflow_dispatch: |
|||
inputs: |
|||
version: |
|||
required: true |
|||
description: Needs to match, exactly, the name of a milestone |
|||
workflow_call: |
|||
inputs: |
|||
version_call: |
|||
description: Needs to match, exactly, the name of a milestone |
|||
required: true |
|||
type: string |
|||
secrets: |
|||
token: |
|||
required: true |
|||
jobs: |
|||
main: |
|||
runs-on: ubuntu-latest |
|||
steps: |
|||
- name: Checkout Actions |
|||
uses: actions/checkout@v2 |
|||
with: |
|||
repository: "grafana/grafana-github-actions" |
|||
path: ./actions |
|||
ref: main |
|||
- name: Install Actions |
|||
run: npm install --production --prefix ./actions |
|||
- name: Remove milestone from open issues (manually invoked) |
|||
if: ${{ github.event.inputs.version != '' }} |
|||
uses: ./actions/remove-milestone |
|||
with: |
|||
token: ${{ secrets.GH_BOT_ACCESS_TOKEN }} |
|||
- name: Remove milestone from open issues (workflow invoked) |
|||
if: ${{ inputs.version_call != '' }} |
|||
uses: ./actions/remove-milestone |
|||
with: |
|||
version_call: ${{ inputs.version_call }} |
|||
token: ${{ secrets.token }} |
|||
@ -0,0 +1,27 @@ |
|||
module.exports = async ({ core, filePath }) => { |
|||
try { |
|||
const fs = require('fs'); |
|||
const content = await readFile(fs, filePath); |
|||
const result = JSON.parse(content); |
|||
|
|||
core.startGroup('Parsing json file...'); |
|||
|
|||
for (const property in result) { |
|||
core.info(`${property} <- ${result[property]}`); |
|||
core.setOutput(property, result[property]); |
|||
} |
|||
|
|||
core.endGroup(); |
|||
} catch (error) { |
|||
core.restFailed(error.message); |
|||
} |
|||
} |
|||
|
|||
async function readFile(fs, path) { |
|||
return new Promise((resolve, reject) => { |
|||
fs.readFile(path, (error, data) => { |
|||
if (error) return reject(error); |
|||
return resolve(data); |
|||
}); |
|||
}); |
|||
} |
|||
@ -0,0 +1,9 @@ |
|||
|
|||
module.exports = async ({ github, context, core }) => { |
|||
const { owner, repo } = context.repo; |
|||
const url = `https://api.github.com/repos/${owner}/${repo}/actions/runs/${context.runId}/jobs` |
|||
const result = await github.request(url) |
|||
const link = `https://github.com/grafana/grafana/runs/${result.data.jobs[0].id}?check_suite_focus=true`; |
|||
|
|||
core.setOutput('link', link); |
|||
} |
|||
@ -0,0 +1,43 @@ |
|||
name: Update changelog |
|||
on: |
|||
workflow_dispatch: |
|||
inputs: |
|||
version: |
|||
required: true |
|||
description: Needs to match, exactly, the name of a milestone |
|||
workflow_call: |
|||
inputs: |
|||
version_call: |
|||
description: Needs to match, exactly, the name of a milestone |
|||
required: true |
|||
type: string |
|||
secrets: |
|||
token: |
|||
required: true |
|||
metricsWriteAPIKey: |
|||
required: true |
|||
jobs: |
|||
main: |
|||
runs-on: ubuntu-latest |
|||
steps: |
|||
- name: Checkout Actions |
|||
uses: actions/checkout@v2 |
|||
with: |
|||
repository: "grafana/grafana-github-actions" |
|||
path: ./actions |
|||
ref: main |
|||
- name: Install Actions |
|||
run: npm install --production --prefix ./actions |
|||
- name: Run update changelog (manually invoked) |
|||
if: ${{ github.event.inputs.version != '' }} |
|||
uses: ./actions/update-changelog |
|||
with: |
|||
token: ${{ secrets.GH_BOT_ACCESS_TOKEN }} |
|||
metricsWriteAPIKey: ${{ secrets.GRAFANA_MISC_STATS_API_KEY }} |
|||
- name: Run update changelog (workflow invoked) |
|||
if: ${{ inputs.version_call != '' }} |
|||
uses: ./actions/update-changelog |
|||
with: |
|||
version_call: ${{ inputs.version_call }} |
|||
token: ${{ secrets.token }} |
|||
metricsWriteAPIKey: ${{ secrets.metricsWriteAPIKey }} |
|||
@ -0,0 +1,158 @@ |
|||
node_modules |
|||
npm-debug.log |
|||
yarn-error.log |
|||
coverage/ |
|||
.aws-config.json |
|||
awsconfig |
|||
/.awcache |
|||
/dist |
|||
/public/build |
|||
public/dist/tsconfig.tsbuildinfo |
|||
/public/views/index.html |
|||
/public/views/error.html |
|||
/emails/dist |
|||
/reports |
|||
/e2e/tmp |
|||
vendor/ |
|||
/docs/menu.yaml |
|||
/requests |
|||
|
|||
# Yarn |
|||
.yarn/* |
|||
!.yarn/patches |
|||
!.yarn/releases |
|||
!.yarn/plugins |
|||
!.yarn/sdks |
|||
!.yarn/versions |
|||
# we temporarily commit this file because yarn downloading it |
|||
# somehow produces different checksum values |
|||
!.yarn/cache/pa11y-ci-https-1e9675e9e1-668c9119bd.zip |
|||
.pnp.* |
|||
|
|||
# Enterprise emails |
|||
/emails/templates/enterprise_* |
|||
/public/emails/enterprise_* |
|||
|
|||
# Enterprise reporting fonts |
|||
/public/fonts/dejavu |
|||
|
|||
# Enterprise devenv |
|||
/devenv/docker/blocks/grafana-enterprise |
|||
|
|||
/tmp |
|||
tools/phantomjs/phantomjs |
|||
tools/phantomjs/phantomjs.exe |
|||
profile.out |
|||
coverage.txt |
|||
|
|||
docs/AWS_S3_BUCKET |
|||
docs/GIT_BRANCH |
|||
docs/GITCOMMIT |
|||
docs/changed-files |
|||
|
|||
# locally required config files |
|||
public/css/*.min.css |
|||
|
|||
# Editor junk |
|||
*.sublime-workspace |
|||
*.swp |
|||
.idea/ |
|||
*.iml |
|||
*.tmp |
|||
.DS_Store |
|||
.vscode/ |
|||
!.vscode/launch.json |
|||
.vs/ |
|||
.eslintcache |
|||
.stylelintcache |
|||
|
|||
/data/* |
|||
/bin/* |
|||
|
|||
# devenv |
|||
/devenv/docker-compose.yaml |
|||
/devenv/.env |
|||
|
|||
conf/custom.ini |
|||
/conf/provisioning/**/custom.yaml |
|||
/conf/provisioning/**/dev.yaml |
|||
/conf/ldap_dev.toml |
|||
/conf/ldap_freeipa.toml |
|||
profile.cov |
|||
/grafana |
|||
/local |
|||
.notouch |
|||
/Makefile.local |
|||
/pkg/cmd/grafana-cli/grafana-cli |
|||
/pkg/cmd/grafana-server/grafana-server |
|||
/pkg/cmd/grafana-server/debug |
|||
/pkg/extensions/* |
|||
/pkg/server/wireexts_enterprise.go |
|||
/pkg/cmd/grafana-cli/runner/wireexts_enterprise.go |
|||
!/pkg/extensions/main.go |
|||
/public/app/extensions |
|||
debug.test |
|||
/examples/*/dist |
|||
/packaging/**/*.rpm |
|||
/packaging/**/*.deb |
|||
/packaging/**/*.tar.gz |
|||
/packaging/**/*.tar.gz.sha256 |
|||
|
|||
# Ignore OSX indexing |
|||
.DS_Store |
|||
|
|||
/vendor/**/*.py |
|||
/vendor/**/*.xml |
|||
/vendor/**/*.yml |
|||
/vendor/**/*_test.go |
|||
/vendor/**/.editorconfig |
|||
*.orig |
|||
|
|||
/devenv/bulk-dashboards/*.json |
|||
/devenv/bulk_alerting_dashboards/*.json |
|||
/devenv/datasources_bulk.yaml |
|||
/devenv/bulk_alerting_dashboards/bulk_alerting_datasources.yaml |
|||
|
|||
/scripts/build/release_publisher/release_publisher |
|||
*.patch |
|||
|
|||
# Ignoring frontend packages specifics |
|||
/packages/**/dist |
|||
/packages/**/compiled |
|||
/packages/**/.rpt2_cache |
|||
/packages/**/tsdoc-metadata.json |
|||
|
|||
# Ignore go local build dependencies |
|||
/scripts/go/bin/** |
|||
|
|||
# Ignore compilation stats from `yarn stats` |
|||
compilation-stats.json |
|||
|
|||
# e2e tests |
|||
/packages/grafana-e2e/cypress/screenshots |
|||
/packages/grafana-e2e/cypress/videos |
|||
/packages/grafana-e2e/cypress/logs |
|||
/e2e/server.log |
|||
/e2e/**/screenshots |
|||
!/e2e/**/screenshots/expected/* |
|||
/e2e/**/videos/* |
|||
|
|||
# a11y tests |
|||
/pa11y-ci-results.json |
|||
/pa11y-ci-report |
|||
|
|||
# report dumping the whole system env |
|||
/report.*.json |
|||
|
|||
# auto generated frontend docs |
|||
/docs/sources/packages_api |
|||
|
|||
# auto generated Go files |
|||
*_gen.go |
|||
|
|||
# Auto-generated localisation files |
|||
public/locales/_build/ |
|||
public/locales/**/*.js |
|||
|
|||
deployment_tools_config.json |
|||
|
|||
@ -0,0 +1,4 @@ |
|||
#!/bin/sh |
|||
. "$(dirname "$0")/_/husky.sh" |
|||
|
|||
yarn run precommit |
|||
@ -0,0 +1,27 @@ |
|||
{ |
|||
"locales": [ |
|||
"en", |
|||
"fr", |
|||
"es" |
|||
], |
|||
"catalogs": [ |
|||
{ |
|||
"path": "public/locales/{locale}/messages", |
|||
"include": [ |
|||
"public/app" |
|||
], |
|||
"exclude": [ |
|||
"**/node_modules/**", |
|||
"public/app/plugins" |
|||
] |
|||
} |
|||
], |
|||
"fallbackLocales": { |
|||
"default": "en" |
|||
}, |
|||
"sourceLocale": "en", |
|||
"format": "po", |
|||
"formatOptions": { |
|||
"lineNumbers": false |
|||
} |
|||
} |
|||
@ -0,0 +1,123 @@ |
|||
var config = { |
|||
defaults: { |
|||
concurrency: 1, |
|||
runners: ['axe'], |
|||
useIncognitoBrowserContext: false, |
|||
chromeLaunchConfig: { |
|||
args: ['--no-sandbox'], |
|||
}, |
|||
// see https://github.com/grafana/grafana/pull/41693#issuecomment-979921463 for context
|
|||
// on why we're ignoring singleValue/react-select-*-placeholder elements
|
|||
hideElements: '#updateVersion, [class*="-singleValue"], [id^="react-select-"][id$="-placeholder"]', |
|||
}, |
|||
|
|||
urls: [ |
|||
{ |
|||
url: '${HOST}/login', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
threshold: 12, |
|||
}, |
|||
{ |
|||
url: '${HOST}/login', |
|||
wait: 500, |
|||
actions: [ |
|||
"wait for element input[name='user'] to be added", |
|||
"set field input[name='user'] to admin", |
|||
"set field input[name='password'] to admin", |
|||
"click element button[aria-label='Login button']", |
|||
"wait for element [aria-label='Skip change password button'] to be visible", |
|||
], |
|||
threshold: 13, |
|||
rootElement: '.main-view', |
|||
}, |
|||
{ |
|||
url: '${HOST}/?orgId=1', |
|||
wait: 500, |
|||
threshold: 0, |
|||
}, |
|||
{ |
|||
url: '${HOST}/d/O6f11TZWk/panel-tests-bar-gauge', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
threshold: 0, |
|||
}, |
|||
{ |
|||
url: '${HOST}/d/O6f11TZWk/panel-tests-bar-gauge?orgId=1&editview=settings', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
threshold: 0, |
|||
}, |
|||
{ |
|||
url: '${HOST}/?orgId=1&search=open', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
threshold: 0, |
|||
}, |
|||
{ |
|||
url: '${HOST}/alerting/list', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
// the unified alerting promotion alert's content contrast is too low
|
|||
// see https://github.com/grafana/grafana/pull/41829
|
|||
threshold: 5, |
|||
}, |
|||
{ |
|||
url: '${HOST}/datasources', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
threshold: 0, |
|||
}, |
|||
{ |
|||
url: '${HOST}/org/users', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
threshold: 0, |
|||
}, |
|||
{ |
|||
url: '${HOST}/org/teams', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
threshold: 0, |
|||
}, |
|||
{ |
|||
url: '${HOST}/plugins', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
threshold: 0, |
|||
}, |
|||
{ |
|||
url: '${HOST}/org', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
threshold: 0, |
|||
}, |
|||
{ |
|||
url: '${HOST}/org/apikeys', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
threshold: 0, |
|||
}, |
|||
{ |
|||
url: '${HOST}/dashboards', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
threshold: 0, |
|||
}, |
|||
], |
|||
}; |
|||
|
|||
function myPa11yCiConfiguration(urls, defaults) { |
|||
const HOST_SERVER = process.env.HOST || 'localhost'; |
|||
const PORT_SERVER = process.env.PORT || '3001'; |
|||
for (var idx = 0; idx < urls.length; idx++) { |
|||
urls[idx] = { ...urls[idx], url: urls[idx].url.replace('${HOST}', `${HOST_SERVER}:${PORT_SERVER}`) }; |
|||
} |
|||
|
|||
return { |
|||
defaults: defaults, |
|||
urls: urls, |
|||
}; |
|||
} |
|||
|
|||
module.exports = myPa11yCiConfiguration(config.urls, config.defaults); |
|||
@ -0,0 +1,106 @@ |
|||
var config = { |
|||
defaults: { |
|||
concurrency: 1, |
|||
runners: ['axe'], |
|||
useIncognitoBrowserContext: false, |
|||
chromeLaunchConfig: { |
|||
args: ['--no-sandbox'], |
|||
}, |
|||
// see https://github.com/grafana/grafana/pull/41693#issuecomment-979921463 for context
|
|||
// on why we're ignoring singleValue/react-select-*-placeholder elements
|
|||
hideElements: '#updateVersion, [class*="-singleValue"], [id^="react-select-"][id$="-placeholder"]', |
|||
}, |
|||
|
|||
urls: [ |
|||
{ |
|||
url: '${HOST}/login', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
}, |
|||
{ |
|||
url: '${HOST}/login', //skip password and login
|
|||
actions: [ |
|||
"wait for element input[name='user'] to be added", |
|||
"set field input[name='user'] to admin", |
|||
"set field input[name='password'] to admin", |
|||
"click element button[aria-label='Login button']", |
|||
"wait for element [aria-label='Skip change password button'] to be visible", |
|||
], |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
}, |
|||
{ |
|||
url: '${HOST}/?orgId=1', |
|||
wait: 500, |
|||
}, |
|||
{ |
|||
url: '${HOST}/d/O6f11TZWk/panel-tests-bar-gauge', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
}, |
|||
{ |
|||
url: '${HOST}/d/O6f11TZWk/panel-tests-bar-gauge?orgId=1&editview=settings', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
}, |
|||
{ |
|||
url: '${HOST}/?orgId=1&search=open', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
}, |
|||
{ |
|||
url: '${HOST}/alerting/list', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
}, |
|||
{ |
|||
url: '${HOST}/datasources', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
}, |
|||
{ |
|||
url: '${HOST}/org/users', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
}, |
|||
{ |
|||
url: '${HOST}/org/teams', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
}, |
|||
{ |
|||
url: '${HOST}/plugins', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
}, |
|||
{ |
|||
url: '${HOST}/org', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
}, |
|||
{ |
|||
url: '${HOST}/org/apikeys', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
}, |
|||
{ |
|||
url: '${HOST}/dashboards', |
|||
wait: 500, |
|||
rootElement: '.main-view', |
|||
}, |
|||
], |
|||
}; |
|||
|
|||
function myPa11yCiConfiguration(urls, defaults) { |
|||
const HOST_SERVER = process.env.HOST || 'localhost'; |
|||
const PORT_SERVER = process.env.PORT || '3001'; |
|||
for (var idx = 0; idx < urls.length; idx++) { |
|||
urls[idx] = { ...urls[idx], url: urls[idx].url.replace('${HOST}', `${HOST_SERVER}:${PORT_SERVER}`) }; |
|||
} |
|||
return { |
|||
defaults: defaults, |
|||
urls: urls, |
|||
}; |
|||
} |
|||
|
|||
module.exports = myPa11yCiConfiguration(config.urls, config.defaults); |
|||
@ -0,0 +1,13 @@ |
|||
.git |
|||
.github |
|||
dist/ |
|||
pkg/ |
|||
node_modules |
|||
public/vendor/ |
|||
vendor/ |
|||
/data/ |
|||
e2e/tmp |
|||
public/build/ |
|||
public/sass/*.generated.scss |
|||
devenv/ |
|||
public/lib/monaco |
|||
@ -0,0 +1,3 @@ |
|||
module.exports = { |
|||
...require('@grafana/toolkit/src/config/prettier.plugin.config.json'), |
|||
}; |
|||
@ -0,0 +1,6 @@ |
|||
{ |
|||
"eslint.packageManager": "yarn", |
|||
"eslint.nodePath": ".yarn/sdks", |
|||
"workspace.workspaceFolderCheckCwd": false, |
|||
"tsserver.tsdk": ".yarn/sdks/typescript/lib" |
|||
} |
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -0,0 +1,20 @@ |
|||
#!/usr/bin/env node
|
|||
|
|||
const {existsSync} = require(`fs`); |
|||
const {createRequire, createRequireFromPath} = require(`module`); |
|||
const {resolve} = require(`path`); |
|||
|
|||
const relPnpApiPath = "../../../../.pnp.cjs"; |
|||
|
|||
const absPnpApiPath = resolve(__dirname, relPnpApiPath); |
|||
const absRequire = (createRequire || createRequireFromPath)(absPnpApiPath); |
|||
|
|||
if (existsSync(absPnpApiPath)) { |
|||
if (!process.versions.pnp) { |
|||
// Setup the environment to be able to require eslint/bin/eslint.js
|
|||
require(absPnpApiPath).setup(); |
|||
} |
|||
} |
|||
|
|||
// Defer to the real eslint/bin/eslint.js your application uses
|
|||
module.exports = absRequire(`eslint/bin/eslint.js`); |
|||
@ -0,0 +1,20 @@ |
|||
#!/usr/bin/env node
|
|||
|
|||
const {existsSync} = require(`fs`); |
|||
const {createRequire, createRequireFromPath} = require(`module`); |
|||
const {resolve} = require(`path`); |
|||
|
|||
const relPnpApiPath = "../../../../.pnp.cjs"; |
|||
|
|||
const absPnpApiPath = resolve(__dirname, relPnpApiPath); |
|||
const absRequire = (createRequire || createRequireFromPath)(absPnpApiPath); |
|||
|
|||
if (existsSync(absPnpApiPath)) { |
|||
if (!process.versions.pnp) { |
|||
// Setup the environment to be able to require eslint
|
|||
require(absPnpApiPath).setup(); |
|||
} |
|||
} |
|||
|
|||
// Defer to the real eslint your application uses
|
|||
module.exports = absRequire(`eslint`); |
|||
@ -0,0 +1,6 @@ |
|||
{ |
|||
"name": "eslint", |
|||
"version": "7.28.0-sdk", |
|||
"main": "./lib/api.js", |
|||
"type": "commonjs" |
|||
} |
|||
@ -0,0 +1,6 @@ |
|||
# This file is automatically generated by @yarnpkg/sdks. |
|||
# Manual changes might be lost! |
|||
|
|||
integrations: |
|||
- vscode |
|||
- vim |
|||
@ -0,0 +1,20 @@ |
|||
#!/usr/bin/env node
|
|||
|
|||
const {existsSync} = require(`fs`); |
|||
const {createRequire, createRequireFromPath} = require(`module`); |
|||
const {resolve} = require(`path`); |
|||
|
|||
const relPnpApiPath = "../../../.pnp.cjs"; |
|||
|
|||
const absPnpApiPath = resolve(__dirname, relPnpApiPath); |
|||
const absRequire = (createRequire || createRequireFromPath)(absPnpApiPath); |
|||
|
|||
if (existsSync(absPnpApiPath)) { |
|||
if (!process.versions.pnp) { |
|||
// Setup the environment to be able to require prettier/index.js
|
|||
require(absPnpApiPath).setup(); |
|||
} |
|||
} |
|||
|
|||
// Defer to the real prettier/index.js your application uses
|
|||
module.exports = absRequire(`prettier/index.js`); |
|||
@ -0,0 +1,6 @@ |
|||
{ |
|||
"name": "prettier", |
|||
"version": "2.2.1-sdk", |
|||
"main": "./index.js", |
|||
"type": "commonjs" |
|||
} |
|||
@ -0,0 +1,20 @@ |
|||
#!/usr/bin/env node
|
|||
|
|||
const {existsSync} = require(`fs`); |
|||
const {createRequire, createRequireFromPath} = require(`module`); |
|||
const {resolve} = require(`path`); |
|||
|
|||
const relPnpApiPath = "../../../../.pnp.cjs"; |
|||
|
|||
const absPnpApiPath = resolve(__dirname, relPnpApiPath); |
|||
const absRequire = (createRequire || createRequireFromPath)(absPnpApiPath); |
|||
|
|||
if (existsSync(absPnpApiPath)) { |
|||
if (!process.versions.pnp) { |
|||
// Setup the environment to be able to require stylelint/bin/stylelint.js
|
|||
require(absPnpApiPath).setup(); |
|||
} |
|||
} |
|||
|
|||
// Defer to the real stylelint/bin/stylelint.js your application uses
|
|||
module.exports = absRequire(`stylelint/bin/stylelint.js`); |
|||
@ -0,0 +1,20 @@ |
|||
#!/usr/bin/env node
|
|||
|
|||
const {existsSync} = require(`fs`); |
|||
const {createRequire, createRequireFromPath} = require(`module`); |
|||
const {resolve} = require(`path`); |
|||
|
|||
const relPnpApiPath = "../../../../.pnp.cjs"; |
|||
|
|||
const absPnpApiPath = resolve(__dirname, relPnpApiPath); |
|||
const absRequire = (createRequire || createRequireFromPath)(absPnpApiPath); |
|||
|
|||
if (existsSync(absPnpApiPath)) { |
|||
if (!process.versions.pnp) { |
|||
// Setup the environment to be able to require stylelint/lib/index.js
|
|||
require(absPnpApiPath).setup(); |
|||
} |
|||
} |
|||
|
|||
// Defer to the real stylelint/lib/index.js your application uses
|
|||
module.exports = absRequire(`stylelint/lib/index.js`); |
|||
@ -0,0 +1,6 @@ |
|||
{ |
|||
"name": "stylelint", |
|||
"version": "14.0.1-sdk", |
|||
"main": "lib/index.js", |
|||
"type": "commonjs" |
|||
} |
|||
@ -0,0 +1,20 @@ |
|||
#!/usr/bin/env node |
|||
|
|||
const {existsSync} = require(`fs`); |
|||
const {createRequire, createRequireFromPath} = require(`module`); |
|||
const {resolve} = require(`path`); |
|||
|
|||
const relPnpApiPath = "../../../../.pnp.cjs"; |
|||
|
|||
const absPnpApiPath = resolve(__dirname, relPnpApiPath); |
|||
const absRequire = (createRequire || createRequireFromPath)(absPnpApiPath); |
|||
|
|||
if (existsSync(absPnpApiPath)) { |
|||
if (!process.versions.pnp) { |
|||
// Setup the environment to be able to require typescript/bin/tsc |
|||
require(absPnpApiPath).setup(); |
|||
} |
|||
} |
|||
|
|||
// Defer to the real typescript/bin/tsc your application uses |
|||
module.exports = absRequire(`typescript/bin/tsc`); |
|||
@ -0,0 +1,20 @@ |
|||
#!/usr/bin/env node |
|||
|
|||
const {existsSync} = require(`fs`); |
|||
const {createRequire, createRequireFromPath} = require(`module`); |
|||
const {resolve} = require(`path`); |
|||
|
|||
const relPnpApiPath = "../../../../.pnp.cjs"; |
|||
|
|||
const absPnpApiPath = resolve(__dirname, relPnpApiPath); |
|||
const absRequire = (createRequire || createRequireFromPath)(absPnpApiPath); |
|||
|
|||
if (existsSync(absPnpApiPath)) { |
|||
if (!process.versions.pnp) { |
|||
// Setup the environment to be able to require typescript/bin/tsserver |
|||
require(absPnpApiPath).setup(); |
|||
} |
|||
} |
|||
|
|||
// Defer to the real typescript/bin/tsserver your application uses |
|||
module.exports = absRequire(`typescript/bin/tsserver`); |
|||
@ -0,0 +1,20 @@ |
|||
#!/usr/bin/env node
|
|||
|
|||
const {existsSync} = require(`fs`); |
|||
const {createRequire, createRequireFromPath} = require(`module`); |
|||
const {resolve} = require(`path`); |
|||
|
|||
const relPnpApiPath = "../../../../.pnp.cjs"; |
|||
|
|||
const absPnpApiPath = resolve(__dirname, relPnpApiPath); |
|||
const absRequire = (createRequire || createRequireFromPath)(absPnpApiPath); |
|||
|
|||
if (existsSync(absPnpApiPath)) { |
|||
if (!process.versions.pnp) { |
|||
// Setup the environment to be able to require typescript/lib/tsc.js
|
|||
require(absPnpApiPath).setup(); |
|||
} |
|||
} |
|||
|
|||
// Defer to the real typescript/lib/tsc.js your application uses
|
|||
module.exports = absRequire(`typescript/lib/tsc.js`); |
|||
@ -0,0 +1,184 @@ |
|||
#!/usr/bin/env node
|
|||
|
|||
const {existsSync} = require(`fs`); |
|||
const {createRequire, createRequireFromPath} = require(`module`); |
|||
const {resolve} = require(`path`); |
|||
|
|||
const relPnpApiPath = "../../../../.pnp.cjs"; |
|||
|
|||
const absPnpApiPath = resolve(__dirname, relPnpApiPath); |
|||
const absRequire = (createRequire || createRequireFromPath)(absPnpApiPath); |
|||
|
|||
const moduleWrapper = tsserver => { |
|||
if (!process.versions.pnp) { |
|||
return tsserver; |
|||
} |
|||
|
|||
const {isAbsolute} = require(`path`); |
|||
const pnpApi = require(`pnpapi`); |
|||
|
|||
const isVirtual = str => str.match(/\/(\$\$virtual|__virtual__)\//); |
|||
const normalize = str => str.replace(/\\/g, `/`).replace(/^\/?/, `/`); |
|||
|
|||
const dependencyTreeRoots = new Set(pnpApi.getDependencyTreeRoots().map(locator => { |
|||
return `${locator.name}@${locator.reference}`; |
|||
})); |
|||
|
|||
// VSCode sends the zip paths to TS using the "zip://" prefix, that TS
|
|||
// doesn't understand. This layer makes sure to remove the protocol
|
|||
// before forwarding it to TS, and to add it back on all returned paths.
|
|||
|
|||
function toEditorPath(str) { |
|||
// We add the `zip:` prefix to both `.zip/` paths and virtual paths
|
|||
if (isAbsolute(str) && !str.match(/^\^?(zip:|\/zip\/)/) && (str.match(/\.zip\//) || isVirtual(str))) { |
|||
// We also take the opportunity to turn virtual paths into physical ones;
|
|||
// this makes it much easier to work with workspaces that list peer
|
|||
// dependencies, since otherwise Ctrl+Click would bring us to the virtual
|
|||
// file instances instead of the real ones.
|
|||
//
|
|||
// We only do this to modules owned by the the dependency tree roots.
|
|||
// This avoids breaking the resolution when jumping inside a vendor
|
|||
// with peer dep (otherwise jumping into react-dom would show resolution
|
|||
// errors on react).
|
|||
//
|
|||
const resolved = isVirtual(str) ? pnpApi.resolveVirtual(str) : str; |
|||
if (resolved) { |
|||
const locator = pnpApi.findPackageLocator(resolved); |
|||
if (locator && dependencyTreeRoots.has(`${locator.name}@${locator.reference}`)) { |
|||
str = resolved; |
|||
} |
|||
} |
|||
|
|||
str = normalize(str); |
|||
|
|||
if (str.match(/\.zip\//)) { |
|||
switch (hostInfo) { |
|||
// Absolute VSCode `Uri.fsPath`s need to start with a slash.
|
|||
// VSCode only adds it automatically for supported schemes,
|
|||
// so we have to do it manually for the `zip` scheme.
|
|||
// The path needs to start with a caret otherwise VSCode doesn't handle the protocol
|
|||
//
|
|||
// Ref: https://github.com/microsoft/vscode/issues/105014#issuecomment-686760910
|
|||
//
|
|||
// Update Oct 8 2021: VSCode changed their format in 1.61.
|
|||
// Before | ^zip:/c:/foo/bar.zip/package.json
|
|||
// After | ^/zip//c:/foo/bar.zip/package.json
|
|||
//
|
|||
case `vscode <1.61`: { |
|||
str = `^zip:${str}`; |
|||
} break; |
|||
|
|||
case `vscode`: { |
|||
str = `^/zip/${str}`; |
|||
} break; |
|||
|
|||
// To make "go to definition" work,
|
|||
// We have to resolve the actual file system path from virtual path
|
|||
// and convert scheme to supported by [vim-rzip](https://github.com/lbrayner/vim-rzip)
|
|||
case `coc-nvim`: { |
|||
str = normalize(resolved).replace(/\.zip\//, `.zip::`); |
|||
str = resolve(`zipfile:${str}`); |
|||
} break; |
|||
|
|||
// Support neovim native LSP and [typescript-language-server](https://github.com/theia-ide/typescript-language-server)
|
|||
// We have to resolve the actual file system path from virtual path,
|
|||
// everything else is up to neovim
|
|||
case `neovim`: { |
|||
str = normalize(resolved).replace(/\.zip\//, `.zip::`); |
|||
str = `zipfile:${str}`; |
|||
} break; |
|||
|
|||
default: { |
|||
str = `zip:${str}`; |
|||
} break; |
|||
} |
|||
} |
|||
} |
|||
|
|||
return str; |
|||
} |
|||
|
|||
function fromEditorPath(str) { |
|||
switch (hostInfo) { |
|||
case `coc-nvim`: |
|||
case `neovim`: { |
|||
str = str.replace(/\.zip::/, `.zip/`); |
|||
// The path for coc-nvim is in format of /<pwd>/zipfile:/<pwd>/.yarn/...
|
|||
// So in order to convert it back, we use .* to match all the thing
|
|||
// before `zipfile:`
|
|||
return process.platform === `win32` |
|||
? str.replace(/^.*zipfile:\//, ``) |
|||
: str.replace(/^.*zipfile:/, ``); |
|||
} break; |
|||
|
|||
case `vscode`: |
|||
default: { |
|||
return process.platform === `win32` |
|||
? str.replace(/^\^?(zip:|\/zip)\/+/, ``) |
|||
: str.replace(/^\^?(zip:|\/zip)\/+/, `/`); |
|||
} break; |
|||
} |
|||
} |
|||
|
|||
// Force enable 'allowLocalPluginLoads'
|
|||
// TypeScript tries to resolve plugins using a path relative to itself
|
|||
// which doesn't work when using the global cache
|
|||
// https://github.com/microsoft/TypeScript/blob/1b57a0395e0bff191581c9606aab92832001de62/src/server/project.ts#L2238
|
|||
// VSCode doesn't want to enable 'allowLocalPluginLoads' due to security concerns but
|
|||
// TypeScript already does local loads and if this code is running the user trusts the workspace
|
|||
// https://github.com/microsoft/vscode/issues/45856
|
|||
const ConfiguredProject = tsserver.server.ConfiguredProject; |
|||
const {enablePluginsWithOptions: originalEnablePluginsWithOptions} = ConfiguredProject.prototype; |
|||
ConfiguredProject.prototype.enablePluginsWithOptions = function() { |
|||
this.projectService.allowLocalPluginLoads = true; |
|||
return originalEnablePluginsWithOptions.apply(this, arguments); |
|||
}; |
|||
|
|||
// And here is the point where we hijack the VSCode <-> TS communications
|
|||
// by adding ourselves in the middle. We locate everything that looks
|
|||
// like an absolute path of ours and normalize it.
|
|||
|
|||
const Session = tsserver.server.Session; |
|||
const {onMessage: originalOnMessage, send: originalSend} = Session.prototype; |
|||
let hostInfo = `unknown`; |
|||
|
|||
Object.assign(Session.prototype, { |
|||
onMessage(/** @type {string} */ message) { |
|||
const parsedMessage = JSON.parse(message) |
|||
|
|||
if ( |
|||
parsedMessage != null && |
|||
typeof parsedMessage === `object` && |
|||
parsedMessage.arguments && |
|||
typeof parsedMessage.arguments.hostInfo === `string` |
|||
) { |
|||
hostInfo = parsedMessage.arguments.hostInfo; |
|||
if (hostInfo === `vscode` && process.env.VSCODE_IPC_HOOK && process.env.VSCODE_IPC_HOOK.match(/Code\/1\.([1-5][0-9]|60)\./)) { |
|||
hostInfo += ` <1.61`; |
|||
} |
|||
} |
|||
|
|||
return originalOnMessage.call(this, JSON.stringify(parsedMessage, (key, value) => { |
|||
return typeof value === `string` ? fromEditorPath(value) : value; |
|||
})); |
|||
}, |
|||
|
|||
send(/** @type {any} */ msg) { |
|||
return originalSend.call(this, JSON.parse(JSON.stringify(msg, (key, value) => { |
|||
return typeof value === `string` ? toEditorPath(value) : value; |
|||
}))); |
|||
} |
|||
}); |
|||
|
|||
return tsserver; |
|||
}; |
|||
|
|||
if (existsSync(absPnpApiPath)) { |
|||
if (!process.versions.pnp) { |
|||
// Setup the environment to be able to require typescript/lib/tsserver.js
|
|||
require(absPnpApiPath).setup(); |
|||
} |
|||
} |
|||
|
|||
// Defer to the real typescript/lib/tsserver.js your application uses
|
|||
module.exports = moduleWrapper(absRequire(`typescript/lib/tsserver.js`)); |
|||
@ -0,0 +1,184 @@ |
|||
#!/usr/bin/env node
|
|||
|
|||
const {existsSync} = require(`fs`); |
|||
const {createRequire, createRequireFromPath} = require(`module`); |
|||
const {resolve} = require(`path`); |
|||
|
|||
const relPnpApiPath = "../../../../.pnp.cjs"; |
|||
|
|||
const absPnpApiPath = resolve(__dirname, relPnpApiPath); |
|||
const absRequire = (createRequire || createRequireFromPath)(absPnpApiPath); |
|||
|
|||
const moduleWrapper = tsserver => { |
|||
if (!process.versions.pnp) { |
|||
return tsserver; |
|||
} |
|||
|
|||
const {isAbsolute} = require(`path`); |
|||
const pnpApi = require(`pnpapi`); |
|||
|
|||
const isVirtual = str => str.match(/\/(\$\$virtual|__virtual__)\//); |
|||
const normalize = str => str.replace(/\\/g, `/`).replace(/^\/?/, `/`); |
|||
|
|||
const dependencyTreeRoots = new Set(pnpApi.getDependencyTreeRoots().map(locator => { |
|||
return `${locator.name}@${locator.reference}`; |
|||
})); |
|||
|
|||
// VSCode sends the zip paths to TS using the "zip://" prefix, that TS
|
|||
// doesn't understand. This layer makes sure to remove the protocol
|
|||
// before forwarding it to TS, and to add it back on all returned paths.
|
|||
|
|||
function toEditorPath(str) { |
|||
// We add the `zip:` prefix to both `.zip/` paths and virtual paths
|
|||
if (isAbsolute(str) && !str.match(/^\^?(zip:|\/zip\/)/) && (str.match(/\.zip\//) || isVirtual(str))) { |
|||
// We also take the opportunity to turn virtual paths into physical ones;
|
|||
// this makes it much easier to work with workspaces that list peer
|
|||
// dependencies, since otherwise Ctrl+Click would bring us to the virtual
|
|||
// file instances instead of the real ones.
|
|||
//
|
|||
// We only do this to modules owned by the the dependency tree roots.
|
|||
// This avoids breaking the resolution when jumping inside a vendor
|
|||
// with peer dep (otherwise jumping into react-dom would show resolution
|
|||
// errors on react).
|
|||
//
|
|||
const resolved = isVirtual(str) ? pnpApi.resolveVirtual(str) : str; |
|||
if (resolved) { |
|||
const locator = pnpApi.findPackageLocator(resolved); |
|||
if (locator && dependencyTreeRoots.has(`${locator.name}@${locator.reference}`)) { |
|||
str = resolved; |
|||
} |
|||
} |
|||
|
|||
str = normalize(str); |
|||
|
|||
if (str.match(/\.zip\//)) { |
|||
switch (hostInfo) { |
|||
// Absolute VSCode `Uri.fsPath`s need to start with a slash.
|
|||
// VSCode only adds it automatically for supported schemes,
|
|||
// so we have to do it manually for the `zip` scheme.
|
|||
// The path needs to start with a caret otherwise VSCode doesn't handle the protocol
|
|||
//
|
|||
// Ref: https://github.com/microsoft/vscode/issues/105014#issuecomment-686760910
|
|||
//
|
|||
// Update Oct 8 2021: VSCode changed their format in 1.61.
|
|||
// Before | ^zip:/c:/foo/bar.zip/package.json
|
|||
// After | ^/zip//c:/foo/bar.zip/package.json
|
|||
//
|
|||
case `vscode <1.61`: { |
|||
str = `^zip:${str}`; |
|||
} break; |
|||
|
|||
case `vscode`: { |
|||
str = `^/zip/${str}`; |
|||
} break; |
|||
|
|||
// To make "go to definition" work,
|
|||
// We have to resolve the actual file system path from virtual path
|
|||
// and convert scheme to supported by [vim-rzip](https://github.com/lbrayner/vim-rzip)
|
|||
case `coc-nvim`: { |
|||
str = normalize(resolved).replace(/\.zip\//, `.zip::`); |
|||
str = resolve(`zipfile:${str}`); |
|||
} break; |
|||
|
|||
// Support neovim native LSP and [typescript-language-server](https://github.com/theia-ide/typescript-language-server)
|
|||
// We have to resolve the actual file system path from virtual path,
|
|||
// everything else is up to neovim
|
|||
case `neovim`: { |
|||
str = normalize(resolved).replace(/\.zip\//, `.zip::`); |
|||
str = `zipfile:${str}`; |
|||
} break; |
|||
|
|||
default: { |
|||
str = `zip:${str}`; |
|||
} break; |
|||
} |
|||
} |
|||
} |
|||
|
|||
return str; |
|||
} |
|||
|
|||
function fromEditorPath(str) { |
|||
switch (hostInfo) { |
|||
case `coc-nvim`: |
|||
case `neovim`: { |
|||
str = str.replace(/\.zip::/, `.zip/`); |
|||
// The path for coc-nvim is in format of /<pwd>/zipfile:/<pwd>/.yarn/...
|
|||
// So in order to convert it back, we use .* to match all the thing
|
|||
// before `zipfile:`
|
|||
return process.platform === `win32` |
|||
? str.replace(/^.*zipfile:\//, ``) |
|||
: str.replace(/^.*zipfile:/, ``); |
|||
} break; |
|||
|
|||
case `vscode`: |
|||
default: { |
|||
return process.platform === `win32` |
|||
? str.replace(/^\^?(zip:|\/zip)\/+/, ``) |
|||
: str.replace(/^\^?(zip:|\/zip)\/+/, `/`); |
|||
} break; |
|||
} |
|||
} |
|||
|
|||
// Force enable 'allowLocalPluginLoads'
|
|||
// TypeScript tries to resolve plugins using a path relative to itself
|
|||
// which doesn't work when using the global cache
|
|||
// https://github.com/microsoft/TypeScript/blob/1b57a0395e0bff191581c9606aab92832001de62/src/server/project.ts#L2238
|
|||
// VSCode doesn't want to enable 'allowLocalPluginLoads' due to security concerns but
|
|||
// TypeScript already does local loads and if this code is running the user trusts the workspace
|
|||
// https://github.com/microsoft/vscode/issues/45856
|
|||
const ConfiguredProject = tsserver.server.ConfiguredProject; |
|||
const {enablePluginsWithOptions: originalEnablePluginsWithOptions} = ConfiguredProject.prototype; |
|||
ConfiguredProject.prototype.enablePluginsWithOptions = function() { |
|||
this.projectService.allowLocalPluginLoads = true; |
|||
return originalEnablePluginsWithOptions.apply(this, arguments); |
|||
}; |
|||
|
|||
// And here is the point where we hijack the VSCode <-> TS communications
|
|||
// by adding ourselves in the middle. We locate everything that looks
|
|||
// like an absolute path of ours and normalize it.
|
|||
|
|||
const Session = tsserver.server.Session; |
|||
const {onMessage: originalOnMessage, send: originalSend} = Session.prototype; |
|||
let hostInfo = `unknown`; |
|||
|
|||
Object.assign(Session.prototype, { |
|||
onMessage(/** @type {string} */ message) { |
|||
const parsedMessage = JSON.parse(message) |
|||
|
|||
if ( |
|||
parsedMessage != null && |
|||
typeof parsedMessage === `object` && |
|||
parsedMessage.arguments && |
|||
typeof parsedMessage.arguments.hostInfo === `string` |
|||
) { |
|||
hostInfo = parsedMessage.arguments.hostInfo; |
|||
if (hostInfo === `vscode` && process.env.VSCODE_IPC_HOOK && process.env.VSCODE_IPC_HOOK.match(/Code\/1\.([1-5][0-9]|60)\./)) { |
|||
hostInfo += ` <1.61`; |
|||
} |
|||
} |
|||
|
|||
return originalOnMessage.call(this, JSON.stringify(parsedMessage, (key, value) => { |
|||
return typeof value === `string` ? fromEditorPath(value) : value; |
|||
})); |
|||
}, |
|||
|
|||
send(/** @type {any} */ msg) { |
|||
return originalSend.call(this, JSON.parse(JSON.stringify(msg, (key, value) => { |
|||
return typeof value === `string` ? toEditorPath(value) : value; |
|||
}))); |
|||
} |
|||
}); |
|||
|
|||
return tsserver; |
|||
}; |
|||
|
|||
if (existsSync(absPnpApiPath)) { |
|||
if (!process.versions.pnp) { |
|||
// Setup the environment to be able to require typescript/lib/tsserverlibrary.js
|
|||
require(absPnpApiPath).setup(); |
|||
} |
|||
} |
|||
|
|||
// Defer to the real typescript/lib/tsserverlibrary.js your application uses
|
|||
module.exports = moduleWrapper(absRequire(`typescript/lib/tsserverlibrary.js`)); |
|||
@ -0,0 +1,20 @@ |
|||
#!/usr/bin/env node
|
|||
|
|||
const {existsSync} = require(`fs`); |
|||
const {createRequire, createRequireFromPath} = require(`module`); |
|||
const {resolve} = require(`path`); |
|||
|
|||
const relPnpApiPath = "../../../../.pnp.cjs"; |
|||
|
|||
const absPnpApiPath = resolve(__dirname, relPnpApiPath); |
|||
const absRequire = (createRequire || createRequireFromPath)(absPnpApiPath); |
|||
|
|||
if (existsSync(absPnpApiPath)) { |
|||
if (!process.versions.pnp) { |
|||
// Setup the environment to be able to require typescript/lib/typescript.js
|
|||
require(absPnpApiPath).setup(); |
|||
} |
|||
} |
|||
|
|||
// Defer to the real typescript/lib/typescript.js your application uses
|
|||
module.exports = absRequire(`typescript/lib/typescript.js`); |
|||
@ -0,0 +1,6 @@ |
|||
{ |
|||
"name": "typescript", |
|||
"version": "4.5.4-sdk", |
|||
"main": "./lib/typescript.js", |
|||
"type": "commonjs" |
|||
} |
|||
@ -0,0 +1,85 @@ |
|||
enableTelemetry: false |
|||
|
|||
nodeLinker: pnp |
|||
|
|||
packageExtensions: |
|||
"@grafana/slate-react@0.22.10-grafana": |
|||
peerDependencies: |
|||
slate-react: ">=0.22.0" |
|||
"@mdx-js/loader@1.6.22": |
|||
peerDependencies: |
|||
react: 17.0.1 |
|||
"@storybook/addon-docs@6.4.4": |
|||
peerDependencies: |
|||
"@storybook/manager-webpack5": 6.4.4 |
|||
"@storybook/addon-essentials@6.4.4": |
|||
peerDependencies: |
|||
"@storybook/components": 6.4.4 |
|||
"@storybook/core-events": 6.4.4 |
|||
"@storybook/manager-webpack5": 6.4.4 |
|||
"@storybook/theming": 6.4.4 |
|||
"@storybook/core-server@6.4.4": |
|||
peerDependencies: |
|||
"@babel/core": ^7.0.0 |
|||
"@storybook/core@6.4.4": |
|||
peerDependencies: |
|||
"@babel/core": ^7.0.0 |
|||
"@storybook/manager-webpack5": 6.4.4 |
|||
"@storybook/csf-tools@6.4.4": |
|||
peerDependencies: |
|||
"@babel/core": ^7.0.0 |
|||
"@storybook/react@6.4.4": |
|||
peerDependencies: |
|||
"@storybook/manager-webpack5": 6.4.4 |
|||
doctrine@3.0.0: |
|||
dependencies: |
|||
assert: 2.0.0 |
|||
moveable@0.27.3: |
|||
dependencies: |
|||
"@daybrush/utils": 1.6.0 |
|||
framework-utils: ^1.1.0 |
|||
rc-time-picker@3.7.3: |
|||
peerDependencies: |
|||
react: 17.0.1 |
|||
react-dom: 17.0.1 |
|||
rc-trigger@2.6.5: |
|||
peerDependencies: |
|||
react: 17.0.1 |
|||
react-dom: 17.0.1 |
|||
react-compat-css-styled@1.0.8: |
|||
dependencies: |
|||
react-simple-compat: 1.2.1 |
|||
react-compat-moveable@0.15.2: |
|||
dependencies: |
|||
"@egjs/agent": ^2.2.1 |
|||
"@egjs/children-differ": ^1.0.1 |
|||
"@scena/matrix": 1.1.1 |
|||
css-to-mat: ^1.0.3 |
|||
gesto: ^1.4.0 |
|||
overlap-area: ^1.0.0 |
|||
react-simple-compat: 1.2.1 |
|||
peerDependencies: |
|||
framework-utils: ^1.1.0 |
|||
react-dev-utils@11.0.4: |
|||
peerDependencies: |
|||
typescript: 4.4.3 |
|||
webpack: 5.51.1 |
|||
react-docgen-typescript-loader@3.7.2: |
|||
peerDependencies: |
|||
webpack: 4.41.5 |
|||
react-icons@2.2.7: |
|||
peerDependencies: |
|||
prop-types: "*" |
|||
react-resizable@3.0.4: |
|||
peerDependencies: |
|||
react-dom: 17.0.1 |
|||
|
|||
plugins: |
|||
- path: .yarn/plugins/@yarnpkg/plugin-typescript.cjs |
|||
spec: "@yarnpkg/plugin-typescript" |
|||
- path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs |
|||
spec: "@yarnpkg/plugin-interactive-tools" |
|||
- path: .yarn/plugins/@yarnpkg/plugin-outdated.cjs |
|||
spec: "https://mskelton.dev/yarn-outdated/v2" |
|||
|
|||
yarnPath: .yarn/releases/yarn-3.1.1.cjs |
|||
File diff suppressed because it is too large
File diff suppressed because it is too large
@ -0,0 +1,46 @@ |
|||
# Contributor Covenant Code of Conduct |
|||
|
|||
## Our Pledge |
|||
|
|||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. |
|||
|
|||
## Our Standards |
|||
|
|||
Examples of behavior that contributes to creating a positive environment include: |
|||
|
|||
- Using welcoming and inclusive language |
|||
- Being respectful of differing viewpoints and experiences |
|||
- Gracefully accepting constructive criticism |
|||
- Focusing on what is best for the community |
|||
- Showing empathy towards other community members |
|||
|
|||
Examples of unacceptable behavior by participants include: |
|||
|
|||
- The use of sexualized language or imagery and unwelcome sexual attention or advances |
|||
- Trolling, insulting/derogatory comments, and personal or political attacks |
|||
- Public or private harassment |
|||
- Publishing others' private information, such as a physical or electronic address, without explicit permission |
|||
- Other conduct which could reasonably be considered inappropriate in a professional setting |
|||
|
|||
## Our Responsibilities |
|||
|
|||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. |
|||
|
|||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. |
|||
|
|||
## Scope |
|||
|
|||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. |
|||
|
|||
## Enforcement |
|||
|
|||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at conduct@grafana.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. |
|||
|
|||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. |
|||
|
|||
## Attribution |
|||
|
|||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] |
|||
|
|||
[homepage]: http://contributor-covenant.org |
|||
[version]: http://contributor-covenant.org/version/1/4/ |
|||
@ -0,0 +1,85 @@ |
|||
# Contributing to Grafana |
|||
|
|||
Thank you for your interest in contributing to Grafana! We welcome all people who want to contribute in a healthy and constructive manner within our community. To help us create a safe and positive community experience for all, we require all participants to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md). |
|||
|
|||
This document is a guide to help you through the process of contributing to Grafana. |
|||
|
|||
## Become a contributor |
|||
|
|||
You can contribute to Grafana in several ways. Here are some examples: |
|||
|
|||
- Contribute to the Grafana codebase. |
|||
- Report and triage bugs. |
|||
- Develop community plugins and dashboards. |
|||
- Write technical documentation and blog posts, for users and contributors. |
|||
- Organize meetups and user groups in your local area. |
|||
- Help others by answering questions about Grafana. |
|||
|
|||
For more ways to contribute, check out the [Open Source Guides](https://opensource.guide/how-to-contribute/). |
|||
|
|||
### Report bugs |
|||
|
|||
Before submitting a new issue, try to make sure someone hasn't already reported the problem. Look through the [existing issues](https://github.com/grafana/grafana/issues) for similar issues. |
|||
|
|||
Report a bug by submitting a [bug report](https://github.com/grafana/grafana/issues/new?labels=type%3A+bug&template=1-bug_report.md). Make sure that you provide as much information as possible on how to reproduce the bug. |
|||
|
|||
Follow the issue template and add additional information that will help us replicate the problem. |
|||
|
|||
For data visualization issues: |
|||
|
|||
- Query results from the inspect drawer (data tab & query inspector) |
|||
- Panel settings can be extracted in the panel inspect drawer JSON tab |
|||
|
|||
For a dashboard related issues: |
|||
|
|||
- Dashboard JSON can be found in the dashboard settings JSON model view |
|||
|
|||
For authentication and alerting Grafana server logs are useful. |
|||
|
|||
#### Security issues |
|||
|
|||
If you believe you've found a security vulnerability, please read our [security policy](https://github.com/grafana/grafana/security/policy) for more details. |
|||
|
|||
### Suggest enhancements |
|||
|
|||
If you have an idea of how to improve Grafana, submit an [enhancement request](https://github.com/grafana/grafana/discussions/new). |
|||
|
|||
We want to make Grafana accessible to even more people. Submit an [accessibility issue](https://github.com/grafana/grafana/issues/new?labels=type%3A+accessibility&template=3-accessibility.md) to help us understand what we can improve. |
|||
|
|||
### Write documentation |
|||
|
|||
To edit or write technical content, refer to [Contribute to our documentation](/contribute/documentation/README.md). We welcome your expertise and input as our body of technical content grows. |
|||
|
|||
### Triage issues |
|||
|
|||
If you don't have the knowledge or time to code, consider helping with _issue triage_. The community will thank you for saving them time by spending some of yours. |
|||
|
|||
Read more about the ways you can [Triage issues](/contribute/triage-issues.md). |
|||
|
|||
### Answering questions |
|||
|
|||
If you have a question and you can't find the answer in the [documentation](https://grafana.com/docs/), the next step is to ask it on the [community site](https://community.grafana.com/). |
|||
|
|||
It's important to us to help these users, and we'd love your help. Sign up to our [community site](https://community.grafana.com/), and start helping other Grafana users by answering their questions. |
|||
|
|||
### Your first contribution |
|||
|
|||
Unsure where to begin contributing to Grafana? Start by browsing issues labeled `beginner friendly` or `help wanted`. |
|||
|
|||
- [Beginner-friendly](https://github.com/grafana/grafana/issues?q=is%3Aopen+is%3Aissue+label%3A%22beginner+friendly%22) issues are generally straightforward to complete. |
|||
- [Help wanted](https://github.com/grafana/grafana/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues are problems we would like the community to help us with regardless of complexity. |
|||
|
|||
If you're looking to make a code change, see how to set up your environment for [local development](contribute/developer-guide.md). |
|||
|
|||
When you're ready to contribute, it's time to [Create a pull request](/contribute/create-pull-request.md). |
|||
|
|||
#### Contributor License Agreement (CLA) |
|||
|
|||
Before we can accept your pull request, you need to [sign our CLA](https://grafana.com/docs/grafana/latest/developers/cla/). If you haven't, our CLA assistant prompts you to when you create your pull request. |
|||
|
|||
## Where do I go from here? |
|||
|
|||
- Set up your [development environment](contribute/developer-guide.md). |
|||
- Learn how to [contribute documentation](contribute/documentation.md). |
|||
- Get started [developing plugins](https://grafana.com/docs/grafana/latest/developers/plugins/) for Grafana. |
|||
- Look through the resources in the [contribute](https://github.com/grafana/grafana/tree/main/contribute) folder. |
|||
@ -0,0 +1,95 @@ |
|||
FROM node:16-alpine3.14 as js-builder |
|||
|
|||
ENV NODE_OPTIONS=--max_old_space_size=8000 |
|||
|
|||
WORKDIR /grafana |
|||
|
|||
COPY package.json yarn.lock .yarnrc.yml ./ |
|||
COPY .yarn .yarn |
|||
COPY packages packages |
|||
COPY plugins-bundled plugins-bundled |
|||
|
|||
RUN yarn install |
|||
|
|||
COPY tsconfig.json .eslintrc .editorconfig .browserslistrc .prettierrc.js babel.config.json ./ |
|||
COPY public public |
|||
COPY tools tools |
|||
COPY scripts scripts |
|||
COPY emails emails |
|||
|
|||
ENV NODE_ENV production |
|||
RUN yarn build |
|||
|
|||
FROM golang:1.17.3-alpine3.14 as go-builder |
|||
|
|||
RUN apk add --no-cache gcc g++ make |
|||
|
|||
WORKDIR /grafana |
|||
|
|||
COPY go.mod go.sum embed.go Makefile build.go package.json ./ |
|||
COPY cue cue |
|||
COPY packages/grafana-schema packages/grafana-schema |
|||
COPY public/app/plugins public/app/plugins |
|||
COPY pkg pkg |
|||
COPY scripts scripts |
|||
COPY cue.mod cue.mod |
|||
COPY .bingo .bingo |
|||
|
|||
RUN go mod verify |
|||
RUN make build-go |
|||
|
|||
# Final stage |
|||
FROM alpine:3.14.3 |
|||
|
|||
LABEL maintainer="Grafana team <hello@grafana.com>" |
|||
|
|||
ARG GF_UID="472" |
|||
ARG GF_GID="0" |
|||
|
|||
ENV PATH="/usr/share/grafana/bin:$PATH" \ |
|||
GF_PATHS_CONFIG="/etc/grafana/grafana.ini" \ |
|||
GF_PATHS_DATA="/var/lib/grafana" \ |
|||
GF_PATHS_HOME="/usr/share/grafana" \ |
|||
GF_PATHS_LOGS="/var/log/grafana" \ |
|||
GF_PATHS_PLUGINS="/var/lib/grafana/plugins" \ |
|||
GF_PATHS_PROVISIONING="/etc/grafana/provisioning" |
|||
|
|||
WORKDIR $GF_PATHS_HOME |
|||
|
|||
RUN apk add --no-cache ca-certificates bash tzdata musl-utils |
|||
RUN apk add --no-cache openssl ncurses-libs ncurses-terminfo-base --repository=http://dl-cdn.alpinelinux.org/alpine/edge/main |
|||
RUN apk upgrade ncurses-libs ncurses-terminfo-base --repository=http://dl-cdn.alpinelinux.org/alpine/edge/main |
|||
RUN apk info -vv | sort |
|||
|
|||
COPY conf ./conf |
|||
|
|||
RUN if [ ! $(getent group "$GF_GID") ]; then \ |
|||
addgroup -S -g $GF_GID grafana; \ |
|||
fi |
|||
|
|||
RUN export GF_GID_NAME=$(getent group $GF_GID | cut -d':' -f1) && \ |
|||
mkdir -p "$GF_PATHS_HOME/.aws" && \ |
|||
adduser -S -u $GF_UID -G "$GF_GID_NAME" grafana && \ |
|||
mkdir -p "$GF_PATHS_PROVISIONING/datasources" \ |
|||
"$GF_PATHS_PROVISIONING/dashboards" \ |
|||
"$GF_PATHS_PROVISIONING/notifiers" \ |
|||
"$GF_PATHS_PROVISIONING/plugins" \ |
|||
"$GF_PATHS_PROVISIONING/access-control" \ |
|||
"$GF_PATHS_LOGS" \ |
|||
"$GF_PATHS_PLUGINS" \ |
|||
"$GF_PATHS_DATA" && \ |
|||
cp "$GF_PATHS_HOME/conf/sample.ini" "$GF_PATHS_CONFIG" && \ |
|||
cp "$GF_PATHS_HOME/conf/ldap.toml" /etc/grafana/ldap.toml && \ |
|||
chown -R "grafana:$GF_GID_NAME" "$GF_PATHS_DATA" "$GF_PATHS_HOME/.aws" "$GF_PATHS_LOGS" "$GF_PATHS_PLUGINS" "$GF_PATHS_PROVISIONING" && \ |
|||
chmod -R 777 "$GF_PATHS_DATA" "$GF_PATHS_HOME/.aws" "$GF_PATHS_LOGS" "$GF_PATHS_PLUGINS" "$GF_PATHS_PROVISIONING" |
|||
|
|||
COPY --from=go-builder /grafana/bin/*/grafana-server /grafana/bin/*/grafana-cli ./bin/ |
|||
COPY --from=js-builder /grafana/public ./public |
|||
COPY --from=js-builder /grafana/tools ./tools |
|||
|
|||
EXPOSE 3000 |
|||
|
|||
COPY ./packaging/docker/run.sh /run.sh |
|||
|
|||
USER grafana |
|||
ENTRYPOINT [ "/run.sh" ] |
|||
@ -0,0 +1,86 @@ |
|||
FROM node:16-alpine3.14 as js-builder |
|||
|
|||
ENV NODE_OPTIONS=--max_old_space_size=8000 |
|||
|
|||
WORKDIR /usr/src/app/ |
|||
|
|||
COPY package.json yarn.lock ./ |
|||
COPY packages packages |
|||
COPY .yarnrc.yml ./ |
|||
COPY .yarn .yarn |
|||
COPY plugins-bundled plugins-bundled |
|||
|
|||
RUN yarn install |
|||
|
|||
COPY tsconfig.json .eslintrc .editorconfig .browserslistrc .prettierrc.js babel.config.json ./ |
|||
COPY public public |
|||
COPY tools tools |
|||
COPY scripts scripts |
|||
COPY emails emails |
|||
|
|||
ENV NODE_ENV production |
|||
RUN yarn build |
|||
|
|||
FROM golang:1.17.3 AS go-builder |
|||
|
|||
WORKDIR /src/grafana |
|||
|
|||
COPY go.mod go.sum embed.go ./ |
|||
COPY Makefile build.go package.json ./ |
|||
COPY .bingo .bingo |
|||
COPY pkg pkg/ |
|||
COPY cue cue/ |
|||
COPY cue.mod cue.mod/ |
|||
COPY packages/grafana-schema packages/grafana-schema/ |
|||
COPY public/app/plugins public/app/plugins/ |
|||
|
|||
RUN go mod verify |
|||
RUN make build-go |
|||
|
|||
FROM ubuntu:20.04 |
|||
|
|||
LABEL maintainer="Grafana team <hello@grafana.com>" |
|||
EXPOSE 3000 |
|||
|
|||
ARG GF_UID="472" |
|||
ARG GF_GID="472" |
|||
|
|||
ENV PATH="/usr/share/grafana/bin:$PATH" \ |
|||
GF_PATHS_CONFIG="/etc/grafana/grafana.ini" \ |
|||
GF_PATHS_DATA="/var/lib/grafana" \ |
|||
GF_PATHS_HOME="/usr/share/grafana" \ |
|||
GF_PATHS_LOGS="/var/log/grafana" \ |
|||
GF_PATHS_PLUGINS="/var/lib/grafana/plugins" \ |
|||
GF_PATHS_PROVISIONING="/etc/grafana/provisioning" |
|||
|
|||
WORKDIR $GF_PATHS_HOME |
|||
|
|||
COPY conf conf |
|||
|
|||
# curl should be part of the image |
|||
RUN apt-get update && apt-get install -y ca-certificates curl |
|||
|
|||
RUN mkdir -p "$GF_PATHS_HOME/.aws" && \ |
|||
addgroup --system --gid $GF_GID grafana && \ |
|||
adduser --uid $GF_UID --system --ingroup grafana grafana && \ |
|||
mkdir -p "$GF_PATHS_PROVISIONING/datasources" \ |
|||
"$GF_PATHS_PROVISIONING/dashboards" \ |
|||
"$GF_PATHS_PROVISIONING/notifiers" \ |
|||
"$GF_PATHS_PROVISIONING/plugins" \ |
|||
"$GF_PATHS_PROVISIONING/access-control" \ |
|||
"$GF_PATHS_LOGS" \ |
|||
"$GF_PATHS_PLUGINS" \ |
|||
"$GF_PATHS_DATA" && \ |
|||
cp conf/sample.ini "$GF_PATHS_CONFIG" && \ |
|||
cp conf/ldap.toml /etc/grafana/ldap.toml && \ |
|||
chown -R grafana:grafana "$GF_PATHS_DATA" "$GF_PATHS_HOME/.aws" "$GF_PATHS_LOGS" "$GF_PATHS_PLUGINS" "$GF_PATHS_PROVISIONING" && \ |
|||
chmod -R 777 "$GF_PATHS_DATA" "$GF_PATHS_HOME/.aws" "$GF_PATHS_LOGS" "$GF_PATHS_PLUGINS" "$GF_PATHS_PROVISIONING" |
|||
|
|||
COPY --from=go-builder /src/grafana/bin/*/grafana-server /src/grafana/bin/*/grafana-cli bin/ |
|||
COPY --from=js-builder /usr/src/app/public public |
|||
COPY --from=js-builder /usr/src/app/tools tools |
|||
|
|||
COPY packaging/docker/run.sh / |
|||
|
|||
USER grafana |
|||
ENTRYPOINT [ "/run.sh" ] |
|||
@ -0,0 +1,208 @@ |
|||
# Governance |
|||
|
|||
This document describes the rules and governance of the project. It is meant to be followed by all the developers of the project and the Grafana community. Common terminology used in this governance document are listed below: |
|||
|
|||
- **Team members**: Any members of the private [grafana-team][team] Google group. |
|||
|
|||
- **Maintainers**: Maintainers lead an individual project or parts thereof ([`MAINTAINERS.md`][maintainers]). |
|||
|
|||
- **Projects**: A single repository in the Grafana GitHub organization and listed below is referred to as a project: |
|||
|
|||
- clock-panel |
|||
- devtools |
|||
- gel-app |
|||
- grafana |
|||
- grafana-github-datasource |
|||
- grafana-image-renderer |
|||
- grafana-kiosk |
|||
- grafana-plugin-sdk-go |
|||
- grafana-polystat-panel |
|||
- grafonnet-lib |
|||
- kairosdb-datasource |
|||
- piechart-panel |
|||
- simple-angular-panel |
|||
- simple-app-plugin |
|||
- simple-datasource |
|||
- simple-datasource-backend |
|||
- simple-json-backend-datasource |
|||
- simple-json-datasource |
|||
- simple-react-panel |
|||
- strava-datasource |
|||
- tutorials |
|||
- worldmap-panel |
|||
|
|||
- **The Grafana project**: The sum of all activities performed under this governance, concerning one or more repositories or the community. |
|||
|
|||
## Values |
|||
|
|||
The Grafana developers and community are expected to follow the values defined in the Grafana Code of Conduct. Furthermore, the Grafana community strives for kindness, giving feedback effectively, and building a welcoming environment. The Grafana developers generally decide by consensus and only resort to conflict resolution by a majority vote if consensus cannot be reached. |
|||
|
|||
## Projects |
|||
|
|||
Each project must have a [`MAINTAINERS.md`][maintainers] file with at least one maintainer. Where a project has a release process, access and documentation should be such that more than one person can perform a release. Releases should be announced on the Grafana Labs blog. Any new projects should be first proposed on the [team mailing list][team] following the voting procedures listed below. |
|||
|
|||
## Decision making |
|||
|
|||
### Team members |
|||
|
|||
Team member status may be given to those who have made ongoing contributions to the Grafana project for at least 3 months. This is usually in the form of code improvements and/or notable work on documentation, but organizing events or user support could also be taken into account. |
|||
|
|||
New members may be proposed by any existing member by email to [grafana-team][team]. It is highly desirable to reach consensus about acceptance of a new member. However, the proposal is ultimately voted on by a formal [supermajority vote](#supermajority-vote). |
|||
|
|||
If the new member proposal is accepted, the proposed team member should be contacted privately via email to confirm or deny their acceptance of team membership. This email will also be CC'd to [grafana-team][team] for record-keeping purposes. |
|||
|
|||
If they choose to accept, the [onboarding](#onboarding) procedure is followed. |
|||
|
|||
Team members may retire at any time by emailing [the team][team]. |
|||
|
|||
Team members can be removed by [supermajority vote](#supermajority-vote) on [the team mailing list][team]. |
|||
For this vote, the member in question is not eligible to vote and does not count towards the quorum. |
|||
Any removal vote can cover only one single person. |
|||
|
|||
Upon death of a member, they leave the team automatically. |
|||
|
|||
In case a member leaves, the [offboarding](#offboarding) procedure is applied. |
|||
|
|||
The current team members are: |
|||
|
|||
- Alexander Zobnin ([Grafana Labs](https://grafana.com/)) |
|||
- Alex Khomenko ([Grafana Labs](https://grafana.com/)) |
|||
- Andrej Ocenas ([Grafana Labs](https://grafana.com/)) |
|||
- Arve Knudsen ([Grafana Labs](https://grafana.com/)) |
|||
- Brian Gann ([Grafana Labs](https://grafana.com/)) |
|||
- Carl Bergquist ([Grafana Labs](https://grafana.com/)) |
|||
- Chris Trott ([Grafana Labs](https://grafana.com/)) |
|||
- Daniel Lee ([Grafana Labs](https://grafana.com/)) |
|||
- David Kaltschmidt ([Grafana Labs](https://grafana.com/)) |
|||
- Diana Payton ([Grafana Labs](https://grafana.com/)) |
|||
- Diana Sarlinska ([Grafana Labs](https://grafana.com/)) |
|||
- Dominik Prokop ([Grafana Labs](https://grafana.com/)) |
|||
- Emil Tullstedt ([Grafana Labs](https://grafana.com/)) |
|||
- Erik Sundell ([Grafana Labs](https://grafana.com/)) |
|||
- Fredrik Enestad ([Soundtrack Your Brand](https://www.soundtrackyourbrand.com/)) |
|||
- Hugo Häggmark ([Grafana Labs](https://grafana.com/)) |
|||
- Ivana Huckova ([Grafana Labs](https://grafana.com/)) |
|||
- Jeroen Op 't Eynde ([Grafana Labs](https://grafana.com/)) |
|||
- Jessica Müller ([Grafana Labs](https://grafana.com/)) |
|||
- Julien Pivotto ([Inuits](https://inuits.eu/)) |
|||
- Kay Delaney ([Grafana Labs](https://grafana.com/)) |
|||
- Kyle Brandt ([Grafana Labs](https://grafana.com/)) |
|||
- Leonard Gram ([Grafana Labs](https://grafana.com/)) |
|||
- Lukas Siatka ([Grafana Labs](https://grafana.com/)) |
|||
- Malcolm Holmes ([Grafana Labs](https://grafana.com/)) |
|||
- Marcus Andersson ([Grafana Labs](https://grafana.com/)) |
|||
- Marcus Efraimsson ([Grafana Labs](https://grafana.com/)) |
|||
- Marcus Olsson ([Grafana Labs](https://grafana.com/)) |
|||
- Mitsuhiro Tanda ([GREE](https://corp.gree.net/jp/en/)) |
|||
- Patrick O’Carroll ([Grafana Labs](https://grafana.com/)) |
|||
- Peter Holmberg ([Grafana Labs](https://grafana.com/)) |
|||
- Richard Hartmann ([Grafana Labs](https://grafana.com/)) |
|||
- Ryan McKinley ([Grafana Labs](https://grafana.com/)) |
|||
- Sofia Papagiannaki ([Grafana Labs](https://grafana.com/)) |
|||
- Stephanie Closson ([Grafana Labs](https://grafana.com/)) |
|||
- Tobias Skarhed ([Grafana Labs](https://grafana.com/)) |
|||
- Torkel Ödegaard ([Grafana Labs](https://grafana.com/)) |
|||
- Utkarsh Bhatnagar ([Tinder](https://www.tinder.com/)) |
|||
- Will Browne ([Grafana Labs](https://grafana.com/)) |
|||
- Zoltán Bedi ([Grafana Labs](https://grafana.com/)) |
|||
|
|||
### Maintainers |
|||
|
|||
Maintainers lead one or more project(s) or parts thereof and serve as a point of conflict resolution amongst the contributors to this project. Ideally, maintainers are also team members, but exceptions are possible for suitable maintainers that, for whatever reason, are not yet team members. |
|||
|
|||
Changes in maintainership have to be announced on the [developers mailing list][devs]. They are decided by [rough consensus](#consensus) and formalized by changing the [`MAINTAINERS.md`][maintainers] file of the respective repository. |
|||
|
|||
Maintainers are granted commit rights to all projects covered by this governance. |
|||
|
|||
A maintainer or committer may resign by notifying the [team mailing list][team]. A maintainer with no project activity for a year is considered to have resigned. Maintainers that wish to resign are encouraged to propose another team member to take over the project. |
|||
|
|||
A project may have multiple maintainers, as long as the responsibilities are clearly agreed upon between them. This includes coordinating who handles which issues and pull requests. |
|||
|
|||
### Technical decisions |
|||
|
|||
Technical decisions that only affect a single project are made informally by the maintainer of this project, and [rough consensus](#consensus) is assumed. Technical decisions that span multiple parts of the Grafana project should be discussed and made on the [Grafana developer mailing list][devs]. |
|||
|
|||
Decisions are usually made by [rough consensus](#consensus). If no consensus can be reached, the matter may be resolved by [majority vote](#majority-vote). |
|||
|
|||
### Governance changes |
|||
|
|||
Changes to this document are made by Grafana Labs. |
|||
|
|||
### Other matters |
|||
|
|||
Any matter that needs a decision may be called to a vote by any member if they deem it necessary. For private or personnel matters, discussion and voting takes place on the [team mailing list][team], otherwise on the [developer mailing list][devs]. |
|||
|
|||
## Voting |
|||
|
|||
The Grafana project usually runs by informal consensus, however sometimes a formal decision must be made. |
|||
|
|||
Depending on the subject matter, as laid out [above](#decision-making), different methods of voting are used. |
|||
|
|||
For all votes, voting must be open for at least one week. The end date should be clearly stated in the call to vote. A vote may be called and closed early if enough votes have come in one way so that further votes cannot change the final decision. |
|||
|
|||
In all cases, all and only [team members](#team-members) are eligible to vote, with the sole exception of the forced removal of a team member, in which said member is not eligible to vote. |
|||
|
|||
Discussion and votes on personnel matters (including but not limited to team membership and maintainership) are held in private on the [team mailing list][team]. All other discussion and votes are held in public on the [developer mailing list][devs]. |
|||
|
|||
For public discussions, anyone interested is encouraged to participate. Formal power to object or vote is limited to [team members](#team-members). |
|||
|
|||
### Consensus |
|||
|
|||
The default decision making mechanism for the Grafana project is [rough][rough] consensus. This means that any decision on technical issues is considered supported by the [team][team] as long as nobody objects or the objection has been considered but not necessarily accommodated. |
|||
|
|||
Silence on any consensus decision is implicit agreement and equivalent to explicit agreement. Explicit agreement may be stated at will. Decisions may, but do not need to be called out and put up for decision on the [developers mailing list][devs] at any time and by anyone. |
|||
|
|||
Consensus decisions can never override or go against the spirit of an earlier explicit vote. |
|||
|
|||
If any [team member](#team-members) raises objections, the team members work together towards a solution that all involved can accept. This solution is again subject to rough consensus. |
|||
|
|||
In case no consensus can be found, but a decision one way or the other must be made, any [team member](#team-members) may call a formal [majority vote](#majority-vote). |
|||
|
|||
### Majority vote |
|||
|
|||
Majority votes must be called explicitly in a separate thread on the appropriate mailing list. The subject must be prefixed with `[VOTE]`. In the body, the call to vote must state the proposal being voted on. It should reference any discussion leading up to this point. |
|||
|
|||
Votes may take the form of a single proposal, with the option to vote yes or no, or the form of multiple alternatives. |
|||
|
|||
A vote on a single proposal is considered successful if more vote in favor than against. |
|||
|
|||
If there are multiple alternatives, members may vote for one or more alternatives, or vote “no” to object to all alternatives. It is not possible to cast an “abstain” vote. A vote on multiple alternatives is considered decided in favor of one alternative if it has received the most votes in favor, and a vote from more than half of those voting. Should no alternative reach this quorum, another vote on a reduced number of options may be called separately. |
|||
|
|||
### Supermajority vote |
|||
|
|||
Supermajority votes must be called explicitly in a separate thread on the appropriate mailing list. The subject must be prefixed with `[VOTE]`. In the body, the call to vote must state the proposal being voted on. It should reference any discussion leading up to this point. |
|||
|
|||
Votes may take the form of a single proposal, with the option to vote yes or no, or the form of multiple alternatives. |
|||
|
|||
A vote on a single proposal is considered successful if at least two thirds of those eligible to vote vote in favor. |
|||
|
|||
If there are multiple alternatives, members may vote for one or more alternatives, or vote “no” to object to all alternatives. A vote on multiple alternatives is considered decided in favor of one alternative if it has received the most votes in favor, and a vote from at least two thirds of those eligible to vote. Should no alternative reach this quorum, another vote on a reduced number of options may be called separately. |
|||
|
|||
## On- / Offboarding |
|||
|
|||
### Onboarding |
|||
|
|||
The new member is |
|||
|
|||
- added to the list of [team members](#team-members). Ideally by sending a PR of their own, at least approving said PR. |
|||
- announced on the [developers mailing list][devs] by an existing team member. Ideally, the new member replies in this thread, acknowledging team membership. |
|||
- added to the projects with commit rights. |
|||
- added to the [team mailing list][team]. |
|||
|
|||
### Offboarding |
|||
|
|||
The ex-member is |
|||
|
|||
- removed from the list of [team members](#team-members). Ideally by sending a PR of their own, at least approving said PR. In case of forced removal, no approval is needed. |
|||
- removed from the projects. Optionally, they can retain maintainership of one or more repositories if the [team](#team-members) agrees. |
|||
- removed from the team mailing list and demoted to a normal member of the other mailing lists. |
|||
- not allowed to call themselves an active team member any more, nor allowed to imply this to be the case. |
|||
- added to a list of previous members if they so choose. |
|||
|
|||
If needed, we reserve the right to publicly announce removal. |
|||
|
|||
[coc]: https://github.com/grafana/grafana/blob/main/CODE_OF_CONDUCT.md |
|||
[devs]: https://groups.google.com/forum/#!forum/grafana-developers |
|||
[maintainers]: https://github.com/grafana/grafana/blob/main/MAINTAINERS.md |
|||
[rough]: https://tools.ietf.org/html/rfc7282 |
|||
[team]: https://groups.google.com/forum/#!forum/grafana-team |
|||
@ -0,0 +1,355 @@ |
|||
# Triage issues |
|||
|
|||
The main goal of issue triage is to categorize all incoming Grafana issues and make sure each issue has all basic information needed for anyone else to understand and be able to start working on it. |
|||
|
|||
> **Note:** This information is for Grafana project Maintainers, Owners, and Admins. If you are a Contributor, then you will not be able to perform most of the tasks in this topic. |
|||
|
|||
The core maintainers of the Grafana project are responsible for categorizing all incoming issues and delegating any critical or important issue to other maintainers. Currently one maintainer each week is responsible. Besides that part, triage provides an important way to contribute to an open source project. |
|||
|
|||
Triage helps ensure issues resolve quickly by: |
|||
|
|||
- Ensuring the issue's intent and purpose is conveyed precisely. This is necessary because it can be difficult for an issue to explain how an end user experiences a problem and what actions they took. |
|||
- Giving a contributor the information they need before they commit to resolving an issue. |
|||
- Lowering the issue count by preventing duplicate issues. |
|||
- Streamlining the development process by preventing duplicate discussions. |
|||
|
|||
If you don't have the knowledge or time to code, consider helping with triage. The community will thank you for saving them time by spending some of yours. |
|||
|
|||
## Simplified flowchart diagram of the issue triage process |
|||
|
|||
<!-- https://textik.com/#610afa78553def29 --> |
|||
|
|||
``` |
|||
+--------------------------+ |
|||
+----------------+ New issue opened/ | |
|||
| | more information added | |
|||
| +-------------+------------+ |
|||
| Ask for more | |
|||
| information +-------------+------------+ |
|||
| | All information needed | |
|||
| +--------+ to categorize the issue? +--------+ |
|||
| | | | | |
|||
| | NO +--------------------------+ YES | |
|||
| | | |
|||
+------+-------+-------------+ +------------+---------+ +----------------------------+ |
|||
| | | | | | |
|||
| label: needs more info | | Needs investigation? +--YES---+ label: needs investigation | |
|||
| | | | | | |
|||
+----------------------------+ +----------------+-----+ +--------------+-------------+ |
|||
NO | | |
|||
| Investigate | |
|||
+-----------+----------+ | |
|||
| label: type/* | | |
|||
| label: area/* +------------------+ |
|||
| label: datasource/* | |
|||
+-----|----------+-----+ |
|||
| | |
|||
| | |
|||
| +--+--------------------+ +--------------------+ |
|||
| | | | label: priority/* | |
|||
| | Needs priority? +--YES---+| milestone? | |
|||
| | | | | |
|||
| +--------------------+--+ +----+---------------+ |
|||
| NO | | |
|||
| | | |
|||
+----+-------------+ +---+----------+ | |
|||
| | | | | |
|||
| Close issue +----------+ Done +------+ |
|||
| | | | |
|||
+------------------+ +--------------+ |
|||
``` |
|||
|
|||
## 1. Find uncategorized issues |
|||
|
|||
To get started with issue triage and finding issues that haven't been triaged you have two alternatives. |
|||
|
|||
### Browse unlabeled issues |
|||
|
|||
The easiest and straight forward way of getting started and finding issues that haven't been triaged is to browse [unlabeled issues](https://github.com/grafana/grafana/issues?q=is%3Aopen+is%3Aissue+no%3Alabel) and starting from the bottom and working yourself to the top. |
|||
|
|||
### Subscribe to all notifications |
|||
|
|||
The more advanced, but recommended way is to subscribe to all notifications from this repository which means that all new issues, pull requests, comments and important status changes are sent to your configured email address. Read this [guide](https://help.github.com/en/articles/watching-and-unwatching-repositories#watching-a-single-repository) for help with setting this up. |
|||
|
|||
It's highly recommended that you setup filters to automatically remove emails from the inbox and label/categorize them accordingly to make it easy for you to understand when you need to act upon a notification or where to look for finding issues that haven't been triaged etc. |
|||
|
|||
Instructions for setting up filters in Gmail can be found [here](#setting-up-gmail-filters). Another alternative is to use [Trailer](https://github.com/ptsochantaris/trailer) or similar software. |
|||
|
|||
## 2. Ensure the issue contains basic information |
|||
|
|||
Before triaging an issue very far, make sure that the issue's author provided the standard issue information. This will help you make an educated recommendation on how to categorize the issue. The Grafana project utilizes [GitHub issue templates](https://help.github.com/en/articles/creating-issue-templates-for-your-repository) to guide contributors to provide standard information that must be included for each type of template or type of issue. |
|||
|
|||
### Standard issue information that must be included |
|||
|
|||
Given a certain [issue template](<[template](https://github.com/grafana/grafana/issues/new/choose)>) have been used by the issue author or depending how the issue is perceived by the issue triage responsible, the following should help you understand what standard issue information that must be included. |
|||
|
|||
#### Bug reports |
|||
|
|||
Should explain what happened, what was expected and how to reproduce it together with any additional information that may help giving a complete picture of what happened such as screenshots, [query inspector](https://community.grafana.com/t/using-grafanas-query-inspector-to-troubleshoot-issues/2630) output and any environment related information that's applicable and/or maybe related to the reported problem: |
|||
|
|||
- Grafana version |
|||
- Data source type & version |
|||
- Platform & OS Grafana is installed on |
|||
- User OS & Browser + versions |
|||
- Using docker + what environment |
|||
- Which plugins |
|||
- Configuration database in use (sqlite, mysql, postgres) |
|||
- Reverse proxy in front of Grafana, what version and configuration |
|||
- Non-default configuration settings |
|||
- Development environment like Go and Node versions, if applicable |
|||
|
|||
#### Enhancement requests |
|||
|
|||
Should explain what enhancement or feature that the author wants to be added and why that is needed. |
|||
|
|||
#### Accessibility issues |
|||
|
|||
This is a mix between a bug report and enhancement request but focused on accessibility issues to help make Grafana improve keyboard navigation, screen-reader support and being accessible to everyone. The report should include relevant WCAG criteria, if applicable. |
|||
|
|||
#### Support requests |
|||
|
|||
In general, if the issue description and title is perceived as a question no more information is needed. |
|||
|
|||
### Good practices |
|||
|
|||
To make it easier for everyone to understand and find issues they're searching for it's suggested as a general rule of thumbs to: |
|||
|
|||
- Make sure that issue titles are named to explain the subject of the issue, has a correct spelling and doesn't include irrelevant information and/or sensitive information. |
|||
- Make sure that issue descriptions doesn't include irrelevant information, information from template that haven't been filled out and/or sensitive information. |
|||
- Do your best effort to change title and description or request suggested changes by adding a comment. |
|||
|
|||
> **Note:** Above rules is applicable to both new and existing issues of the Grafana project. |
|||
|
|||
### Do you have all the information needed to categorize an issue? |
|||
|
|||
Depending on the issue, you might not feel all this information is needed. Use your best judgement. If you cannot triage an issue using what its author provided, explain kindly to the author that they must provide the above information to clarify the problem. Label issue with `needs more detail` and add any related `area/*` or `datasource/*` labels. |
|||
|
|||
If the author provides the standard information but you are still unable to triage the issue, request additional information. Do this kindly and politely because you are asking for more of the author's time. |
|||
|
|||
If the author does not respond to the requested information within the timespan of a week, close the issue with a kind note stating that the author can request for the issue to be reopened when the necessary information is provided. |
|||
|
|||
When you feel you have all the information needed you're ready to [categorizing the issue](#3-categorizing-an-issue). |
|||
|
|||
If you receive a notification with additional information provided but you are not anymore on issue triage and you feel you do not have time to handle it, you should delegate it to the current person on issue triage. |
|||
|
|||
## 3. Categorizing an issue |
|||
|
|||
An issue can have multiple of the following labels. Typically, a properly categorized issue should at least have: |
|||
|
|||
- One label identifying its type (`type/*`). |
|||
- One or multiple labels identifying the functional areas of interest or component (`area/*`) and/or data source (`datasource/*`), if applicable. |
|||
|
|||
| Label | Description | |
|||
| ------------------------ | ------------------------------------------------------------------------- | |
|||
| `type/bug` | A feature isn't working as expected given design or documentation. | |
|||
| `type/feature-request` | Request for a new feature or enhancement. | |
|||
| `type/docs` | Documentation problem or enhancement. | |
|||
| `type/accessibility` | Accessibility problem or enhancement. | |
|||
| `type/question` | Issue is a question or is perceived as such. | |
|||
| `type/duplicate` | An existing issue of the same subject/request have already been reported. | |
|||
| `type/works-as-intended` | A reported bug works as intended/by design. | |
|||
| `type/build-packaging` | Build or packaging problem or enhancement. | |
|||
| `area/*` | Subject is related to a functional area of interest or component. | |
|||
| `datasource/*` | Subject is related to a core data source plugin. | |
|||
|
|||
### Duplicate issues |
|||
|
|||
Make sure it's not a duplicate by searching existing issues using related terms from the issue title and description. If you think you know there is an existing issue, but can't find it, please reach out to one of the maintainers and ask for help. If you identify that the issue is a duplicate of an existing issue: |
|||
|
|||
1. Add a comment `/duplicate of #<issue number>`. GitHub will recognize this and add some additional context to the issue activity. |
|||
2. The Grafana bot will do the rest, adding the correct label and closing comment |
|||
3. Optionally add any related `area/*` or `datasource/*` labels. |
|||
|
|||
### Bug reports |
|||
|
|||
If it's not perfectly clear that it's an actual bug, quickly try to reproduce it. |
|||
|
|||
**It's a bug/it can be reproduced:** |
|||
|
|||
1. Add a comment describing detailed steps for how to reproduce it, if applicable. |
|||
2. Label the issue `type/bug` and at least one `area/*` or `datasource/*` label. |
|||
3. If you know that maintainers wont be able to put any resources into it for some time then label the issue with `help wanted` and optionally `beginner friendly` together with pointers on which code to update to fix the bug. This should signal to the community that we would appreciate any help we can get to resolve this. |
|||
4. Move on to [prioritizing the issue](#4-prioritization-of-issues). |
|||
|
|||
**It can't be reproduced:** |
|||
|
|||
1. Either [ask for more information](#2-ensure-the-issue-contains-basic-information) needed to investigate it more thoroughly. |
|||
2. Either [delegate further investigations](#investigation-of-issues) to someone else. |
|||
|
|||
**It works as intended/by design:** |
|||
|
|||
1. Kindly and politely add a comment explaining briefly why we think it works as intended and close the issue. |
|||
2. Label the issue `type/works-as-intended`. |
|||
|
|||
### Enhancement/feature? |
|||
|
|||
1. Label the issue `type/feature-request` and at least one `area/*` or `datasource/*` label. |
|||
2. Move on to [prioritizing the issue](#4-prioritization-of-issues). |
|||
|
|||
### Documentation issue? |
|||
|
|||
First, evaluate if the documentation makes sense to be included in the Grafana project: |
|||
|
|||
- Is this something we want/can maintain as a project? |
|||
- Is this referring to usage of some specific integration/tool and in that case is that a popular use case in combination with Grafana? |
|||
- If unsure, kindly and politely add a comment explaining that we would need [upvotes](https://help.github.com/en/articles/about-conversations-on-github#reacting-to-ideas-in-comments) to identify that lots of other users want/need this. |
|||
|
|||
Second, label the issue `type/docs` and at least one `area/*` or `datasource/*` label. |
|||
|
|||
**Minor typo/error/lack of information:** |
|||
|
|||
There's a minor typo/error/lack of information that adds a lot of confusion for users and given the amount of work is a big win to make sure fixing it: |
|||
|
|||
1. Either update the documentation yourself and open a pull request. |
|||
2. Either delegate the work to someone else by assigning that person to the issue and add the issue to next major/minor milestone. |
|||
|
|||
**Major error/lack of information:** |
|||
|
|||
1. Label the issue with `help wanted` and `beginner friendly`, if applicable, to signal that we find this important to fix and we would appreciate any help we can get from the community. |
|||
2. Move on to [prioritizing the issue](#4-prioritization-of-issues). |
|||
|
|||
### Accessibility issues |
|||
|
|||
1. Label the issue `type/accessibility` and at least one `area/*` or `datasource/*` label. |
|||
|
|||
### Support requests |
|||
|
|||
1. Kindly and politely direct the issue author to the [community site](https://community.grafana.com/) and explain that GitHub is mainly used for tracking bugs and feature requests. If possible, it's usually a good idea to add some pointers to the issue author's question. |
|||
2. Close the issue and label it with `type/question`. |
|||
|
|||
## 4. Prioritization of issues |
|||
|
|||
In general bugs and enhancement issues should be labeled with a priority. |
|||
|
|||
This is the most difficult thing with triaging issues since it requires a lot of knowledge, context and experience before being able to think of and start feel comfortable adding a certain priority label. |
|||
|
|||
The key here is asking for help and discuss issues to understand how more experienced project members think and reason. By doing that you learn more and eventually be more and more comfortable with prioritizing issues. |
|||
|
|||
In case there is an uncertainty around the prioritization of an issue, please ask the maintainers for help. |
|||
|
|||
| Label | Description | |
|||
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | |
|||
| `priority/critical` | Highest priority. Must be actively worked on as someone's top priority right now. | |
|||
| `priority/support-subscription` | This is important for one or several customers having a paid Grafana support subscription. | |
|||
| `priority/important-soon` | Must be staffed and worked on either currently, or very soon, ideally in time for the next release. | |
|||
| `priority/important-longterm` | Important over the long term, but may not be staffed and/or may need multiple releases to complete. | |
|||
| `priority/nice-to-have` | It's a good idea, but not scheduled for any release. | |
|||
| `priority/awaiting-more-evidence` | Lowest priority. Possibly useful, but not yet enough interest in it. | |
|||
| `priority/unscheduled` | Something to look into before and to be discussed during the planning of the next (upcoming) major/minor stable release. | |
|||
|
|||
**Critical bugs** |
|||
|
|||
1. If a bug has been categorized and any of the following criteria apply, the bug should be labeled as critical and must be actively worked on as someone's top priority right now. |
|||
|
|||
- Results in any data loss |
|||
- Critical security or performance issues |
|||
- Problem that makes a feature unusable |
|||
- Multiple users experience a severe problem affecting their business, users etc. |
|||
|
|||
2. Label the issue `priority/critical`. |
|||
3. If applicable, label the issue `priority/support-subscription`. |
|||
4. Add the issue to the next upcoming patch release milestone. Create a new milestone if there are none. |
|||
5. Escalate the problem to the maintainers. |
|||
6. Assign or ask a maintainer for help assigning someone to make this issue their top priority right now. |
|||
|
|||
**Important short-term** |
|||
|
|||
1. Label the issue `priority/important-soon`. |
|||
2. If applicable, label the issue `priority/support-subscription`. |
|||
3. Add the issue to the next upcoming patch or major/minor stable release milestone. Ask maintainers for help if unsure if it's a patch or not. Create a new milestone if there are none. |
|||
4. Make sure to add the issue to a suitable backlog of a GitHub project and prioritize it or assign someone to work on it now or very soon. |
|||
5. Consider requesting [help from the community](#5-requesting-help-from-the-community), even though it may be problematic given a short amount of time until it should be released. |
|||
|
|||
**Important long-term** |
|||
|
|||
1. Label the issue `priority/important-longterm`. |
|||
2. Consider requesting [help from the community](#5-requesting-help-from-the-community). |
|||
|
|||
**Nice to have** |
|||
|
|||
1. Label the issue `priority/nice-to-have`. |
|||
2. Consider requesting [help from the community](#5-requesting-help-from-the-community). |
|||
|
|||
**Not critical, but unsure?** |
|||
|
|||
1. Label the issue `priority/unscheduled`. |
|||
2. Consider requesting [help from the community](#5-requesting-help-from-the-community). |
|||
|
|||
## 5. Requesting help from the community |
|||
|
|||
Depending on the issue and/or priority, it's always a good idea to consider signalling to the community that help from community is appreciated and needed in case an issue is not prioritized to be worked on by maintainers. Use your best judgement. In general, requesting help from the community means that a contribution has a good chance of getting accepted and merged. |
|||
|
|||
In many cases the issue author or community as a whole is more suitable to contribute changes since they're experts in their domain. It's also quite common that someone has tried to get something to work using the documentation without success and made an effort to get it to work and/or reached out to the [community site](https://community.grafana.com/) to get the missing information. Particularly in these areas it's more likely that there exist experts in their own domain and it is usually a good idea to request help from contributors: |
|||
|
|||
- Database setups |
|||
- Authentication like OAuth providers and LDAP setups |
|||
- Platform specific things |
|||
- Reverse proxy setups |
|||
- Alert notifiers |
|||
|
|||
1. Kindly and politely add a comment to signal to users subscribed to updates of the issue. |
|||
- Explain that the issue would be nice to get resolved, but it isn't prioritized to work on by maintainers for an unforeseen future. |
|||
- If possible or applicable, try to help contributors getting starting by adding pointers and references to what code/files need to be changed and/or ideas of a good way to solve/implement the issue. |
|||
2. Label the issue with `help wanted`. |
|||
3. If applicable, label the issue with `beginner friendly` to denote that the issue is suitable for a beginner to work on. |
|||
4. If possible, try to estimate the amount of work by adding `effort/small`, `effort/medium` or `effort/large`. |
|||
|
|||
## Investigation of issues |
|||
|
|||
When an issue has all basic information provided, but the triage responsible haven't been able to reproduce the reported problem at a first glance, the issue is labeled [Needs investigation](https://github.com/grafana/grafana/labels/needs%20investigation). Depending on the perceived severity and/or number of [upvotes](https://help.github.com/en/articles/about-conversations-on-github#reacting-to-ideas-in-comments), the investigation will either be delegated to another maintainer for further investigation or put on hold until someone else (maintainer or contributor) picks it up and eventually starts investigating it. |
|||
|
|||
Investigating issues can be a very time consuming task, especially for the maintainers, given the huge number of combinations of plugins, data sources, platforms, databases, browsers, tools, hardware, integrations, versions and cloud services, etc that are being used with Grafana. There is a certain number of combinations that are more common than others, and these are in general easier for maintainers to investigate. |
|||
|
|||
For some other combinations it may not be possible at all for a maintainer to setup a proper test environment to investigate the issue. In these cases we really appreciate any help we can get from the community. Otherwise the issue is highly likely to be closed. |
|||
|
|||
Even if you don't have the time or knowledge to investigate an issue we highly recommend that you [upvote](https://help.github.com/en/articles/about-conversations-on-github#reacting-to-ideas-in-comments) the issue if you happen to have the same problem. If you have further details that may help investigating the issue please provide as much information as possible. |
|||
|
|||
## Automation |
|||
|
|||
We have some automation that triggers on comments or labels being added to issues. Many of these automated behaviors are defined in [commands.json](https://github.com/grafana/grafana/blob/main/.github/commands.json). Or in other [GitHub Actions](https://github.com/grafana/grafana/tree/main/.github/workflows) |
|||
|
|||
- Add /duplicate `#<issue number>` to have Grafana label & close issue with an appropriate message. |
|||
- Add `bot/question` and the bot will close it with an appropriate message. |
|||
|
|||
[Read more on bot actions](https://github.com/grafana/grafana/blob/main/.github/bot.md) |
|||
|
|||
## External PRs |
|||
|
|||
Part of issue triage should also be triaging of external PRs. Main goal should be to make sure PRs from external contributors have an owner/reviewer and are not forgotten. |
|||
|
|||
1. Check new external PRs which do not have a reviewer. |
|||
1. Check if there is a link to an existing issue. |
|||
1. If not and you know which issue it is solving, add the link yourself, otherwise ask the author to link the issue or create one. |
|||
1. Assign a reviewer based on who was handling the linked issue or what code or feature does the PR touches (look at who was the last to make changes there if all else fails). |
|||
|
|||
## Appendix |
|||
|
|||
### Setting up Gmail filters |
|||
|
|||
If you're using Gmail it's highly recommended that you setup filters to automatically remove email from the inbox and label them accordingly to make it easy for you to understand when you need to act upon a notification or process all incoming issues that haven't been triaged. |
|||
|
|||
This may be setup by personal preference, but here's a working configuration for reference. |
|||
|
|||
1. Follow instructions in [gist](https://gist.github.com/marefr/9167c2e31466f6316c1cba118874e74f) |
|||
2. In Gmail, go to Settings -> Filters and Blocked Addresses |
|||
3. Import filters -> select xml file -> Open file |
|||
4. Review filters |
|||
5. Optional, Check Apply new filters to existing email |
|||
6. Create filters |
|||
|
|||
This will give you a structure of labels in the sidebar similar to the following: |
|||
|
|||
``` |
|||
- Inbox |
|||
... |
|||
- GitHub (mine) |
|||
- activity |
|||
- assigned |
|||
- mentions |
|||
- GitHub (other) |
|||
- Grafana |
|||
``` |
|||
|
|||
- All notifications you’ll need to read/take action on show up as unread in GitHub (mine) and its sub-labels. |
|||
- All other notifications you don’t need to take action on show up as unread in GitHub (other) and its sub-labels |
|||
- This is convenient for issue triage and to follow the activity in the Grafana project. |
|||
@ -0,0 +1,661 @@ |
|||
GNU AFFERO GENERAL PUBLIC LICENSE |
|||
Version 3, 19 November 2007 |
|||
|
|||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> |
|||
Everyone is permitted to copy and distribute verbatim copies |
|||
of this license document, but changing it is not allowed. |
|||
|
|||
Preamble |
|||
|
|||
The GNU Affero General Public License is a free, copyleft license for |
|||
software and other kinds of works, specifically designed to ensure |
|||
cooperation with the community in the case of network server software. |
|||
|
|||
The licenses for most software and other practical works are designed |
|||
to take away your freedom to share and change the works. By contrast, |
|||
our General Public Licenses are intended to guarantee your freedom to |
|||
share and change all versions of a program--to make sure it remains free |
|||
software for all its users. |
|||
|
|||
When we speak of free software, we are referring to freedom, not |
|||
price. Our General Public Licenses are designed to make sure that you |
|||
have the freedom to distribute copies of free software (and charge for |
|||
them if you wish), that you receive source code or can get it if you |
|||
want it, that you can change the software or use pieces of it in new |
|||
free programs, and that you know you can do these things. |
|||
|
|||
Developers that use our General Public Licenses protect your rights |
|||
with two steps: (1) assert copyright on the software, and (2) offer |
|||
you this License which gives you legal permission to copy, distribute |
|||
and/or modify the software. |
|||
|
|||
A secondary benefit of defending all users' freedom is that |
|||
improvements made in alternate versions of the program, if they |
|||
receive widespread use, become available for other developers to |
|||
incorporate. Many developers of free software are heartened and |
|||
encouraged by the resulting cooperation. However, in the case of |
|||
software used on network servers, this result may fail to come about. |
|||
The GNU General Public License permits making a modified version and |
|||
letting the public access it on a server without ever releasing its |
|||
source code to the public. |
|||
|
|||
The GNU Affero General Public License is designed specifically to |
|||
ensure that, in such cases, the modified source code becomes available |
|||
to the community. It requires the operator of a network server to |
|||
provide the source code of the modified version running there to the |
|||
users of that server. Therefore, public use of a modified version, on |
|||
a publicly accessible server, gives the public access to the source |
|||
code of the modified version. |
|||
|
|||
An older license, called the Affero General Public License and |
|||
published by Affero, was designed to accomplish similar goals. This is |
|||
a different license, not a version of the Affero GPL, but Affero has |
|||
released a new version of the Affero GPL which permits relicensing under |
|||
this license. |
|||
|
|||
The precise terms and conditions for copying, distribution and |
|||
modification follow. |
|||
|
|||
TERMS AND CONDITIONS |
|||
|
|||
0. Definitions. |
|||
|
|||
"This License" refers to version 3 of the GNU Affero General Public License. |
|||
|
|||
"Copyright" also means copyright-like laws that apply to other kinds of |
|||
works, such as semiconductor masks. |
|||
|
|||
"The Program" refers to any copyrightable work licensed under this |
|||
License. Each licensee is addressed as "you". "Licensees" and |
|||
"recipients" may be individuals or organizations. |
|||
|
|||
To "modify" a work means to copy from or adapt all or part of the work |
|||
in a fashion requiring copyright permission, other than the making of an |
|||
exact copy. The resulting work is called a "modified version" of the |
|||
earlier work or a work "based on" the earlier work. |
|||
|
|||
A "covered work" means either the unmodified Program or a work based |
|||
on the Program. |
|||
|
|||
To "propagate" a work means to do anything with it that, without |
|||
permission, would make you directly or secondarily liable for |
|||
infringement under applicable copyright law, except executing it on a |
|||
computer or modifying a private copy. Propagation includes copying, |
|||
distribution (with or without modification), making available to the |
|||
public, and in some countries other activities as well. |
|||
|
|||
To "convey" a work means any kind of propagation that enables other |
|||
parties to make or receive copies. Mere interaction with a user through |
|||
a computer network, with no transfer of a copy, is not conveying. |
|||
|
|||
An interactive user interface displays "Appropriate Legal Notices" |
|||
to the extent that it includes a convenient and prominently visible |
|||
feature that (1) displays an appropriate copyright notice, and (2) |
|||
tells the user that there is no warranty for the work (except to the |
|||
extent that warranties are provided), that licensees may convey the |
|||
work under this License, and how to view a copy of this License. If |
|||
the interface presents a list of user commands or options, such as a |
|||
menu, a prominent item in the list meets this criterion. |
|||
|
|||
1. Source Code. |
|||
|
|||
The "source code" for a work means the preferred form of the work |
|||
for making modifications to it. "Object code" means any non-source |
|||
form of a work. |
|||
|
|||
A "Standard Interface" means an interface that either is an official |
|||
standard defined by a recognized standards body, or, in the case of |
|||
interfaces specified for a particular programming language, one that |
|||
is widely used among developers working in that language. |
|||
|
|||
The "System Libraries" of an executable work include anything, other |
|||
than the work as a whole, that (a) is included in the normal form of |
|||
packaging a Major Component, but which is not part of that Major |
|||
Component, and (b) serves only to enable use of the work with that |
|||
Major Component, or to implement a Standard Interface for which an |
|||
implementation is available to the public in source code form. A |
|||
"Major Component", in this context, means a major essential component |
|||
(kernel, window system, and so on) of the specific operating system |
|||
(if any) on which the executable work runs, or a compiler used to |
|||
produce the work, or an object code interpreter used to run it. |
|||
|
|||
The "Corresponding Source" for a work in object code form means all |
|||
the source code needed to generate, install, and (for an executable |
|||
work) run the object code and to modify the work, including scripts to |
|||
control those activities. However, it does not include the work's |
|||
System Libraries, or general-purpose tools or generally available free |
|||
programs which are used unmodified in performing those activities but |
|||
which are not part of the work. For example, Corresponding Source |
|||
includes interface definition files associated with source files for |
|||
the work, and the source code for shared libraries and dynamically |
|||
linked subprograms that the work is specifically designed to require, |
|||
such as by intimate data communication or control flow between those |
|||
subprograms and other parts of the work. |
|||
|
|||
The Corresponding Source need not include anything that users |
|||
can regenerate automatically from other parts of the Corresponding |
|||
Source. |
|||
|
|||
The Corresponding Source for a work in source code form is that |
|||
same work. |
|||
|
|||
2. Basic Permissions. |
|||
|
|||
All rights granted under this License are granted for the term of |
|||
copyright on the Program, and are irrevocable provided the stated |
|||
conditions are met. This License explicitly affirms your unlimited |
|||
permission to run the unmodified Program. The output from running a |
|||
covered work is covered by this License only if the output, given its |
|||
content, constitutes a covered work. This License acknowledges your |
|||
rights of fair use or other equivalent, as provided by copyright law. |
|||
|
|||
You may make, run and propagate covered works that you do not |
|||
convey, without conditions so long as your license otherwise remains |
|||
in force. You may convey covered works to others for the sole purpose |
|||
of having them make modifications exclusively for you, or provide you |
|||
with facilities for running those works, provided that you comply with |
|||
the terms of this License in conveying all material for which you do |
|||
not control copyright. Those thus making or running the covered works |
|||
for you must do so exclusively on your behalf, under your direction |
|||
and control, on terms that prohibit them from making any copies of |
|||
your copyrighted material outside their relationship with you. |
|||
|
|||
Conveying under any other circumstances is permitted solely under |
|||
the conditions stated below. Sublicensing is not allowed; section 10 |
|||
makes it unnecessary. |
|||
|
|||
3. Protecting Users' Legal Rights From Anti-Circumvention Law. |
|||
|
|||
No covered work shall be deemed part of an effective technological |
|||
measure under any applicable law fulfilling obligations under article |
|||
11 of the WIPO copyright treaty adopted on 20 December 1996, or |
|||
similar laws prohibiting or restricting circumvention of such |
|||
measures. |
|||
|
|||
When you convey a covered work, you waive any legal power to forbid |
|||
circumvention of technological measures to the extent such circumvention |
|||
is effected by exercising rights under this License with respect to |
|||
the covered work, and you disclaim any intention to limit operation or |
|||
modification of the work as a means of enforcing, against the work's |
|||
users, your or third parties' legal rights to forbid circumvention of |
|||
technological measures. |
|||
|
|||
4. Conveying Verbatim Copies. |
|||
|
|||
You may convey verbatim copies of the Program's source code as you |
|||
receive it, in any medium, provided that you conspicuously and |
|||
appropriately publish on each copy an appropriate copyright notice; |
|||
keep intact all notices stating that this License and any |
|||
non-permissive terms added in accord with section 7 apply to the code; |
|||
keep intact all notices of the absence of any warranty; and give all |
|||
recipients a copy of this License along with the Program. |
|||
|
|||
You may charge any price or no price for each copy that you convey, |
|||
and you may offer support or warranty protection for a fee. |
|||
|
|||
5. Conveying Modified Source Versions. |
|||
|
|||
You may convey a work based on the Program, or the modifications to |
|||
produce it from the Program, in the form of source code under the |
|||
terms of section 4, provided that you also meet all of these conditions: |
|||
|
|||
a) The work must carry prominent notices stating that you modified |
|||
it, and giving a relevant date. |
|||
|
|||
b) The work must carry prominent notices stating that it is |
|||
released under this License and any conditions added under section |
|||
7. This requirement modifies the requirement in section 4 to |
|||
"keep intact all notices". |
|||
|
|||
c) You must license the entire work, as a whole, under this |
|||
License to anyone who comes into possession of a copy. This |
|||
License will therefore apply, along with any applicable section 7 |
|||
additional terms, to the whole of the work, and all its parts, |
|||
regardless of how they are packaged. This License gives no |
|||
permission to license the work in any other way, but it does not |
|||
invalidate such permission if you have separately received it. |
|||
|
|||
d) If the work has interactive user interfaces, each must display |
|||
Appropriate Legal Notices; however, if the Program has interactive |
|||
interfaces that do not display Appropriate Legal Notices, your |
|||
work need not make them do so. |
|||
|
|||
A compilation of a covered work with other separate and independent |
|||
works, which are not by their nature extensions of the covered work, |
|||
and which are not combined with it such as to form a larger program, |
|||
in or on a volume of a storage or distribution medium, is called an |
|||
"aggregate" if the compilation and its resulting copyright are not |
|||
used to limit the access or legal rights of the compilation's users |
|||
beyond what the individual works permit. Inclusion of a covered work |
|||
in an aggregate does not cause this License to apply to the other |
|||
parts of the aggregate. |
|||
|
|||
6. Conveying Non-Source Forms. |
|||
|
|||
You may convey a covered work in object code form under the terms |
|||
of sections 4 and 5, provided that you also convey the |
|||
machine-readable Corresponding Source under the terms of this License, |
|||
in one of these ways: |
|||
|
|||
a) Convey the object code in, or embodied in, a physical product |
|||
(including a physical distribution medium), accompanied by the |
|||
Corresponding Source fixed on a durable physical medium |
|||
customarily used for software interchange. |
|||
|
|||
b) Convey the object code in, or embodied in, a physical product |
|||
(including a physical distribution medium), accompanied by a |
|||
written offer, valid for at least three years and valid for as |
|||
long as you offer spare parts or customer support for that product |
|||
model, to give anyone who possesses the object code either (1) a |
|||
copy of the Corresponding Source for all the software in the |
|||
product that is covered by this License, on a durable physical |
|||
medium customarily used for software interchange, for a price no |
|||
more than your reasonable cost of physically performing this |
|||
conveying of source, or (2) access to copy the |
|||
Corresponding Source from a network server at no charge. |
|||
|
|||
c) Convey individual copies of the object code with a copy of the |
|||
written offer to provide the Corresponding Source. This |
|||
alternative is allowed only occasionally and noncommercially, and |
|||
only if you received the object code with such an offer, in accord |
|||
with subsection 6b. |
|||
|
|||
d) Convey the object code by offering access from a designated |
|||
place (gratis or for a charge), and offer equivalent access to the |
|||
Corresponding Source in the same way through the same place at no |
|||
further charge. You need not require recipients to copy the |
|||
Corresponding Source along with the object code. If the place to |
|||
copy the object code is a network server, the Corresponding Source |
|||
may be on a different server (operated by you or a third party) |
|||
that supports equivalent copying facilities, provided you maintain |
|||
clear directions next to the object code saying where to find the |
|||
Corresponding Source. Regardless of what server hosts the |
|||
Corresponding Source, you remain obligated to ensure that it is |
|||
available for as long as needed to satisfy these requirements. |
|||
|
|||
e) Convey the object code using peer-to-peer transmission, provided |
|||
you inform other peers where the object code and Corresponding |
|||
Source of the work are being offered to the general public at no |
|||
charge under subsection 6d. |
|||
|
|||
A separable portion of the object code, whose source code is excluded |
|||
from the Corresponding Source as a System Library, need not be |
|||
included in conveying the object code work. |
|||
|
|||
A "User Product" is either (1) a "consumer product", which means any |
|||
tangible personal property which is normally used for personal, family, |
|||
or household purposes, or (2) anything designed or sold for incorporation |
|||
into a dwelling. In determining whether a product is a consumer product, |
|||
doubtful cases shall be resolved in favor of coverage. For a particular |
|||
product received by a particular user, "normally used" refers to a |
|||
typical or common use of that class of product, regardless of the status |
|||
of the particular user or of the way in which the particular user |
|||
actually uses, or expects or is expected to use, the product. A product |
|||
is a consumer product regardless of whether the product has substantial |
|||
commercial, industrial or non-consumer uses, unless such uses represent |
|||
the only significant mode of use of the product. |
|||
|
|||
"Installation Information" for a User Product means any methods, |
|||
procedures, authorization keys, or other information required to install |
|||
and execute modified versions of a covered work in that User Product from |
|||
a modified version of its Corresponding Source. The information must |
|||
suffice to ensure that the continued functioning of the modified object |
|||
code is in no case prevented or interfered with solely because |
|||
modification has been made. |
|||
|
|||
If you convey an object code work under this section in, or with, or |
|||
specifically for use in, a User Product, and the conveying occurs as |
|||
part of a transaction in which the right of possession and use of the |
|||
User Product is transferred to the recipient in perpetuity or for a |
|||
fixed term (regardless of how the transaction is characterized), the |
|||
Corresponding Source conveyed under this section must be accompanied |
|||
by the Installation Information. But this requirement does not apply |
|||
if neither you nor any third party retains the ability to install |
|||
modified object code on the User Product (for example, the work has |
|||
been installed in ROM). |
|||
|
|||
The requirement to provide Installation Information does not include a |
|||
requirement to continue to provide support service, warranty, or updates |
|||
for a work that has been modified or installed by the recipient, or for |
|||
the User Product in which it has been modified or installed. Access to a |
|||
network may be denied when the modification itself materially and |
|||
adversely affects the operation of the network or violates the rules and |
|||
protocols for communication across the network. |
|||
|
|||
Corresponding Source conveyed, and Installation Information provided, |
|||
in accord with this section must be in a format that is publicly |
|||
documented (and with an implementation available to the public in |
|||
source code form), and must require no special password or key for |
|||
unpacking, reading or copying. |
|||
|
|||
7. Additional Terms. |
|||
|
|||
"Additional permissions" are terms that supplement the terms of this |
|||
License by making exceptions from one or more of its conditions. |
|||
Additional permissions that are applicable to the entire Program shall |
|||
be treated as though they were included in this License, to the extent |
|||
that they are valid under applicable law. If additional permissions |
|||
apply only to part of the Program, that part may be used separately |
|||
under those permissions, but the entire Program remains governed by |
|||
this License without regard to the additional permissions. |
|||
|
|||
When you convey a copy of a covered work, you may at your option |
|||
remove any additional permissions from that copy, or from any part of |
|||
it. (Additional permissions may be written to require their own |
|||
removal in certain cases when you modify the work.) You may place |
|||
additional permissions on material, added by you to a covered work, |
|||
for which you have or can give appropriate copyright permission. |
|||
|
|||
Notwithstanding any other provision of this License, for material you |
|||
add to a covered work, you may (if authorized by the copyright holders of |
|||
that material) supplement the terms of this License with terms: |
|||
|
|||
a) Disclaiming warranty or limiting liability differently from the |
|||
terms of sections 15 and 16 of this License; or |
|||
|
|||
b) Requiring preservation of specified reasonable legal notices or |
|||
author attributions in that material or in the Appropriate Legal |
|||
Notices displayed by works containing it; or |
|||
|
|||
c) Prohibiting misrepresentation of the origin of that material, or |
|||
requiring that modified versions of such material be marked in |
|||
reasonable ways as different from the original version; or |
|||
|
|||
d) Limiting the use for publicity purposes of names of licensors or |
|||
authors of the material; or |
|||
|
|||
e) Declining to grant rights under trademark law for use of some |
|||
trade names, trademarks, or service marks; or |
|||
|
|||
f) Requiring indemnification of licensors and authors of that |
|||
material by anyone who conveys the material (or modified versions of |
|||
it) with contractual assumptions of liability to the recipient, for |
|||
any liability that these contractual assumptions directly impose on |
|||
those licensors and authors. |
|||
|
|||
All other non-permissive additional terms are considered "further |
|||
restrictions" within the meaning of section 10. If the Program as you |
|||
received it, or any part of it, contains a notice stating that it is |
|||
governed by this License along with a term that is a further |
|||
restriction, you may remove that term. If a license document contains |
|||
a further restriction but permits relicensing or conveying under this |
|||
License, you may add to a covered work material governed by the terms |
|||
of that license document, provided that the further restriction does |
|||
not survive such relicensing or conveying. |
|||
|
|||
If you add terms to a covered work in accord with this section, you |
|||
must place, in the relevant source files, a statement of the |
|||
additional terms that apply to those files, or a notice indicating |
|||
where to find the applicable terms. |
|||
|
|||
Additional terms, permissive or non-permissive, may be stated in the |
|||
form of a separately written license, or stated as exceptions; |
|||
the above requirements apply either way. |
|||
|
|||
8. Termination. |
|||
|
|||
You may not propagate or modify a covered work except as expressly |
|||
provided under this License. Any attempt otherwise to propagate or |
|||
modify it is void, and will automatically terminate your rights under |
|||
this License (including any patent licenses granted under the third |
|||
paragraph of section 11). |
|||
|
|||
However, if you cease all violation of this License, then your |
|||
license from a particular copyright holder is reinstated (a) |
|||
provisionally, unless and until the copyright holder explicitly and |
|||
finally terminates your license, and (b) permanently, if the copyright |
|||
holder fails to notify you of the violation by some reasonable means |
|||
prior to 60 days after the cessation. |
|||
|
|||
Moreover, your license from a particular copyright holder is |
|||
reinstated permanently if the copyright holder notifies you of the |
|||
violation by some reasonable means, this is the first time you have |
|||
received notice of violation of this License (for any work) from that |
|||
copyright holder, and you cure the violation prior to 30 days after |
|||
your receipt of the notice. |
|||
|
|||
Termination of your rights under this section does not terminate the |
|||
licenses of parties who have received copies or rights from you under |
|||
this License. If your rights have been terminated and not permanently |
|||
reinstated, you do not qualify to receive new licenses for the same |
|||
material under section 10. |
|||
|
|||
9. Acceptance Not Required for Having Copies. |
|||
|
|||
You are not required to accept this License in order to receive or |
|||
run a copy of the Program. Ancillary propagation of a covered work |
|||
occurring solely as a consequence of using peer-to-peer transmission |
|||
to receive a copy likewise does not require acceptance. However, |
|||
nothing other than this License grants you permission to propagate or |
|||
modify any covered work. These actions infringe copyright if you do |
|||
not accept this License. Therefore, by modifying or propagating a |
|||
covered work, you indicate your acceptance of this License to do so. |
|||
|
|||
10. Automatic Licensing of Downstream Recipients. |
|||
|
|||
Each time you convey a covered work, the recipient automatically |
|||
receives a license from the original licensors, to run, modify and |
|||
propagate that work, subject to this License. You are not responsible |
|||
for enforcing compliance by third parties with this License. |
|||
|
|||
An "entity transaction" is a transaction transferring control of an |
|||
organization, or substantially all assets of one, or subdividing an |
|||
organization, or merging organizations. If propagation of a covered |
|||
work results from an entity transaction, each party to that |
|||
transaction who receives a copy of the work also receives whatever |
|||
licenses to the work the party's predecessor in interest had or could |
|||
give under the previous paragraph, plus a right to possession of the |
|||
Corresponding Source of the work from the predecessor in interest, if |
|||
the predecessor has it or can get it with reasonable efforts. |
|||
|
|||
You may not impose any further restrictions on the exercise of the |
|||
rights granted or affirmed under this License. For example, you may |
|||
not impose a license fee, royalty, or other charge for exercise of |
|||
rights granted under this License, and you may not initiate litigation |
|||
(including a cross-claim or counterclaim in a lawsuit) alleging that |
|||
any patent claim is infringed by making, using, selling, offering for |
|||
sale, or importing the Program or any portion of it. |
|||
|
|||
11. Patents. |
|||
|
|||
A "contributor" is a copyright holder who authorizes use under this |
|||
License of the Program or a work on which the Program is based. The |
|||
work thus licensed is called the contributor's "contributor version". |
|||
|
|||
A contributor's "essential patent claims" are all patent claims |
|||
owned or controlled by the contributor, whether already acquired or |
|||
hereafter acquired, that would be infringed by some manner, permitted |
|||
by this License, of making, using, or selling its contributor version, |
|||
but do not include claims that would be infringed only as a |
|||
consequence of further modification of the contributor version. For |
|||
purposes of this definition, "control" includes the right to grant |
|||
patent sublicenses in a manner consistent with the requirements of |
|||
this License. |
|||
|
|||
Each contributor grants you a non-exclusive, worldwide, royalty-free |
|||
patent license under the contributor's essential patent claims, to |
|||
make, use, sell, offer for sale, import and otherwise run, modify and |
|||
propagate the contents of its contributor version. |
|||
|
|||
In the following three paragraphs, a "patent license" is any express |
|||
agreement or commitment, however denominated, not to enforce a patent |
|||
(such as an express permission to practice a patent or covenant not to |
|||
sue for patent infringement). To "grant" such a patent license to a |
|||
party means to make such an agreement or commitment not to enforce a |
|||
patent against the party. |
|||
|
|||
If you convey a covered work, knowingly relying on a patent license, |
|||
and the Corresponding Source of the work is not available for anyone |
|||
to copy, free of charge and under the terms of this License, through a |
|||
publicly available network server or other readily accessible means, |
|||
then you must either (1) cause the Corresponding Source to be so |
|||
available, or (2) arrange to deprive yourself of the benefit of the |
|||
patent license for this particular work, or (3) arrange, in a manner |
|||
consistent with the requirements of this License, to extend the patent |
|||
license to downstream recipients. "Knowingly relying" means you have |
|||
actual knowledge that, but for the patent license, your conveying the |
|||
covered work in a country, or your recipient's use of the covered work |
|||
in a country, would infringe one or more identifiable patents in that |
|||
country that you have reason to believe are valid. |
|||
|
|||
If, pursuant to or in connection with a single transaction or |
|||
arrangement, you convey, or propagate by procuring conveyance of, a |
|||
covered work, and grant a patent license to some of the parties |
|||
receiving the covered work authorizing them to use, propagate, modify |
|||
or convey a specific copy of the covered work, then the patent license |
|||
you grant is automatically extended to all recipients of the covered |
|||
work and works based on it. |
|||
|
|||
A patent license is "discriminatory" if it does not include within |
|||
the scope of its coverage, prohibits the exercise of, or is |
|||
conditioned on the non-exercise of one or more of the rights that are |
|||
specifically granted under this License. You may not convey a covered |
|||
work if you are a party to an arrangement with a third party that is |
|||
in the business of distributing software, under which you make payment |
|||
to the third party based on the extent of your activity of conveying |
|||
the work, and under which the third party grants, to any of the |
|||
parties who would receive the covered work from you, a discriminatory |
|||
patent license (a) in connection with copies of the covered work |
|||
conveyed by you (or copies made from those copies), or (b) primarily |
|||
for and in connection with specific products or compilations that |
|||
contain the covered work, unless you entered into that arrangement, |
|||
or that patent license was granted, prior to 28 March 2007. |
|||
|
|||
Nothing in this License shall be construed as excluding or limiting |
|||
any implied license or other defenses to infringement that may |
|||
otherwise be available to you under applicable patent law. |
|||
|
|||
12. No Surrender of Others' Freedom. |
|||
|
|||
If conditions are imposed on you (whether by court order, agreement or |
|||
otherwise) that contradict the conditions of this License, they do not |
|||
excuse you from the conditions of this License. If you cannot convey a |
|||
covered work so as to satisfy simultaneously your obligations under this |
|||
License and any other pertinent obligations, then as a consequence you may |
|||
not convey it at all. For example, if you agree to terms that obligate you |
|||
to collect a royalty for further conveying from those to whom you convey |
|||
the Program, the only way you could satisfy both those terms and this |
|||
License would be to refrain entirely from conveying the Program. |
|||
|
|||
13. Remote Network Interaction; Use with the GNU General Public License. |
|||
|
|||
Notwithstanding any other provision of this License, if you modify the |
|||
Program, your modified version must prominently offer all users |
|||
interacting with it remotely through a computer network (if your version |
|||
supports such interaction) an opportunity to receive the Corresponding |
|||
Source of your version by providing access to the Corresponding Source |
|||
from a network server at no charge, through some standard or customary |
|||
means of facilitating copying of software. This Corresponding Source |
|||
shall include the Corresponding Source for any work covered by version 3 |
|||
of the GNU General Public License that is incorporated pursuant to the |
|||
following paragraph. |
|||
|
|||
Notwithstanding any other provision of this License, you have |
|||
permission to link or combine any covered work with a work licensed |
|||
under version 3 of the GNU General Public License into a single |
|||
combined work, and to convey the resulting work. The terms of this |
|||
License will continue to apply to the part which is the covered work, |
|||
but the work with which it is combined will remain governed by version |
|||
3 of the GNU General Public License. |
|||
|
|||
14. Revised Versions of this License. |
|||
|
|||
The Free Software Foundation may publish revised and/or new versions of |
|||
the GNU Affero General Public License from time to time. Such new versions |
|||
will be similar in spirit to the present version, but may differ in detail to |
|||
address new problems or concerns. |
|||
|
|||
Each version is given a distinguishing version number. If the |
|||
Program specifies that a certain numbered version of the GNU Affero General |
|||
Public License "or any later version" applies to it, you have the |
|||
option of following the terms and conditions either of that numbered |
|||
version or of any later version published by the Free Software |
|||
Foundation. If the Program does not specify a version number of the |
|||
GNU Affero General Public License, you may choose any version ever published |
|||
by the Free Software Foundation. |
|||
|
|||
If the Program specifies that a proxy can decide which future |
|||
versions of the GNU Affero General Public License can be used, that proxy's |
|||
public statement of acceptance of a version permanently authorizes you |
|||
to choose that version for the Program. |
|||
|
|||
Later license versions may give you additional or different |
|||
permissions. However, no additional obligations are imposed on any |
|||
author or copyright holder as a result of your choosing to follow a |
|||
later version. |
|||
|
|||
15. Disclaimer of Warranty. |
|||
|
|||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY |
|||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT |
|||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY |
|||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, |
|||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
|||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM |
|||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF |
|||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION. |
|||
|
|||
16. Limitation of Liability. |
|||
|
|||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING |
|||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS |
|||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY |
|||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE |
|||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF |
|||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD |
|||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), |
|||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF |
|||
SUCH DAMAGES. |
|||
|
|||
17. Interpretation of Sections 15 and 16. |
|||
|
|||
If the disclaimer of warranty and limitation of liability provided |
|||
above cannot be given local legal effect according to their terms, |
|||
reviewing courts shall apply local law that most closely approximates |
|||
an absolute waiver of all civil liability in connection with the |
|||
Program, unless a warranty or assumption of liability accompanies a |
|||
copy of the Program in return for a fee. |
|||
|
|||
END OF TERMS AND CONDITIONS |
|||
|
|||
How to Apply These Terms to Your New Programs |
|||
|
|||
If you develop a new program, and you want it to be of the greatest |
|||
possible use to the public, the best way to achieve this is to make it |
|||
free software which everyone can redistribute and change under these terms. |
|||
|
|||
To do so, attach the following notices to the program. It is safest |
|||
to attach them to the start of each source file to most effectively |
|||
state the exclusion of warranty; and each file should have at least |
|||
the "copyright" line and a pointer to where the full notice is found. |
|||
|
|||
<one line to give the program's name and a brief idea of what it does.> |
|||
Copyright (C) <year> <name of author> |
|||
|
|||
This program is free software: you can redistribute it and/or modify |
|||
it under the terms of the GNU Affero General Public License as published by |
|||
the Free Software Foundation, either version 3 of the License, or |
|||
(at your option) any later version. |
|||
|
|||
This program is distributed in the hope that it will be useful, |
|||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|||
GNU Affero General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Affero General Public License |
|||
along with this program. If not, see <https://www.gnu.org/licenses/>. |
|||
|
|||
Also add information on how to contact you by electronic and paper mail. |
|||
|
|||
If your software can interact with users remotely through a computer |
|||
network, you should also make sure that it provides a way for users to |
|||
get its source. For example, if your program is a web application, its |
|||
interface could display a "Source" link that leads users to an archive |
|||
of the code. There are many ways you could offer source, and different |
|||
solutions will be better for different programs; see section 13 for the |
|||
specific requirements. |
|||
|
|||
You should also get your employer (if you work as a programmer) or school, |
|||
if any, to sign a "copyright disclaimer" for the program, if necessary. |
|||
For more information on this, and how to apply and follow the GNU AGPL, see |
|||
<https://www.gnu.org/licenses/>. |
|||
@ -0,0 +1,28 @@ |
|||
# Licensing |
|||
|
|||
License names used in this document are as per [SPDX License List](https://spdx.org/licenses/). |
|||
|
|||
The default license for this project is [AGPL-3.0-only](LICENSE). |
|||
|
|||
## Apache-2.0 |
|||
|
|||
The following directories and their subdirectories are licensed under Apache-2.0: |
|||
|
|||
``` |
|||
packages/grafana-data/ |
|||
packages/grafana-e2e/ |
|||
packages/grafana-e2e-selectors/ |
|||
packages/grafana-runtime/ |
|||
packages/grafana-toolkit/ |
|||
packages/grafana-ui/ |
|||
packages/jaeger-ui-components/ |
|||
packaging/ |
|||
grafana-mixin/ |
|||
cue/ |
|||
``` |
|||
|
|||
The following directories and their subdirectories are the original upstream licenses: |
|||
|
|||
``` |
|||
public/vendor/ |
|||
``` |
|||
@ -0,0 +1,8 @@ |
|||
@torkelo is the main/default maintainer, some parts of the codebase have other maintainers: |
|||
|
|||
- Backend: |
|||
- @bergquist |
|||
- Plugins: |
|||
- @ryantxu |
|||
- UX/UI: |
|||
- @davkal |
|||
@ -0,0 +1,158 @@ |
|||
## This is a self-documented Makefile. For usage information, run `make help`:
|
|||
##
|
|||
## For more information, refer to https://suva.sh/posts/well-documented-makefiles/
|
|||
|
|||
WIRE_TAGS = "oss" |
|||
|
|||
-include local/Makefile |
|||
include .bingo/Variables.mk |
|||
|
|||
.PHONY: all deps-go deps-js deps build-go build-server build-cli build-js build build-docker-full lint-go golangci-lint test-go test-js gen-ts test run run-frontend clean devenv devenv-down protobuf drone help |
|||
|
|||
GO = go |
|||
GO_FILES ?= ./pkg/... |
|||
SH_FILES ?= $(shell find ./scripts -name *.sh) |
|||
|
|||
all: deps build |
|||
|
|||
##@ Dependencies
|
|||
|
|||
deps-go: ## Install backend dependencies.
|
|||
$(GO) run build.go setup |
|||
|
|||
deps-js: node_modules ## Install frontend dependencies.
|
|||
|
|||
deps: deps-js ## Install all dependencies.
|
|||
|
|||
node_modules: package.json yarn.lock ## Install node modules.
|
|||
@echo "install frontend dependencies" |
|||
YARN_ENABLE_PROGRESS_BARS=false yarn install --immutable |
|||
|
|||
##@ Building
|
|||
|
|||
gen-go: $(WIRE) |
|||
@echo "generate go files" |
|||
$(WIRE) gen -tags $(WIRE_TAGS) ./pkg/server ./pkg/cmd/grafana-cli/runner |
|||
|
|||
build-go: gen-go ## Build all Go binaries.
|
|||
@echo "build go files" |
|||
$(GO) run build.go build |
|||
|
|||
build-server: ## Build Grafana server.
|
|||
@echo "build server" |
|||
$(GO) run build.go build-server |
|||
|
|||
build-cli: ## Build Grafana CLI application.
|
|||
@echo "build grafana-cli" |
|||
$(GO) run build.go build-cli |
|||
|
|||
build-js: ## Build frontend assets.
|
|||
@echo "build frontend" |
|||
yarn run build |
|||
yarn run plugins:build-bundled |
|||
|
|||
build: build-go build-js ## Build backend and frontend.
|
|||
|
|||
scripts/go/bin/bra: scripts/go/go.mod |
|||
@cd scripts/go; \
|
|||
$(GO) build -o ./bin/bra github.com/unknwon/bra |
|||
|
|||
run: scripts/go/bin/bra ## Build and run web server on filesystem changes.
|
|||
@scripts/go/bin/bra run |
|||
|
|||
run-frontend: deps-js ## Fetch js dependencies and watch frontend for rebuild
|
|||
yarn start |
|||
|
|||
##@ Testing
|
|||
|
|||
test-go: ## Run tests for backend.
|
|||
@echo "test backend" |
|||
$(GO) test -v ./pkg/... |
|||
|
|||
test-js: ## Run tests for frontend.
|
|||
@echo "test frontend" |
|||
yarn test |
|||
|
|||
test: test-go test-js ## Run all tests.
|
|||
|
|||
##@ Linting
|
|||
scripts/go/bin/golangci-lint: scripts/go/go.mod |
|||
@cd scripts/go; \
|
|||
$(GO) build -o ./bin/golangci-lint github.com/golangci/golangci-lint/cmd/golangci-lint |
|||
|
|||
golangci-lint: scripts/go/bin/golangci-lint |
|||
@echo "lint via golangci-lint" |
|||
@scripts/go/bin/golangci-lint run \
|
|||
--config ./scripts/go/configs/.golangci.toml \
|
|||
$(GO_FILES) |
|||
|
|||
lint-go: golangci-lint ## Run all code checks for backend. You can use GO_FILES to specify exact files to check
|
|||
|
|||
# with disabled SC1071 we are ignored some TCL,Expect `/usr/bin/env expect` scripts
|
|||
shellcheck: $(SH_FILES) ## Run checks for shell scripts.
|
|||
@docker run --rm -v "$$PWD:/mnt" koalaman/shellcheck:stable \
|
|||
$(SH_FILES) -e SC1071 -e SC2162 |
|||
|
|||
##@ Docker
|
|||
|
|||
build-docker-full: ## Build Docker image for development.
|
|||
@echo "build docker container" |
|||
docker build --tag grafana/grafana:dev . |
|||
|
|||
##@ Services
|
|||
|
|||
# create docker-compose file with provided sources and start them
|
|||
# example: make devenv sources=postgres,openldap
|
|||
ifeq ($(sources),) |
|||
devenv: |
|||
@printf 'You have to define sources for this command \nexample: make devenv sources=postgres,openldap\n' |
|||
else |
|||
devenv: devenv-down ## Start optional services, e.g. postgres, prometheus, and elasticsearch.
|
|||
$(eval targets := $(shell echo '$(sources)' | tr "," " ")) |
|||
|
|||
@cd devenv; \
|
|||
./create_docker_compose.sh $(targets) || \
|
|||
(rm -rf {docker-compose.yaml,conf.tmp,.env}; exit 1) |
|||
|
|||
@cd devenv; \
|
|||
docker-compose up -d --build |
|||
endif |
|||
|
|||
devenv-down: ## Stop optional services.
|
|||
@cd devenv; \
|
|||
test -f docker-compose.yaml && \
|
|||
docker-compose down || exit 0; |
|||
|
|||
##@ Helpers
|
|||
|
|||
# We separate the protobuf generation because most development tasks on
|
|||
# Grafana do not involve changing protobuf files and protoc is not a
|
|||
# go-gettable dependency and so getting it installed can be inconvenient.
|
|||
#
|
|||
# If you are working on changes to protobuf interfaces you may either use
|
|||
# this target or run the individual scripts below directly.
|
|||
protobuf: ## Compile protobuf definitions
|
|||
bash scripts/protobuf-check.sh |
|||
bash pkg/plugins/backendplugin/pluginextensionv2/generate.sh |
|||
|
|||
clean: ## Clean up intermediate build artifacts.
|
|||
@echo "cleaning" |
|||
rm -rf node_modules |
|||
rm -rf public/build |
|||
|
|||
gen-ts: |
|||
@echo "generating TypeScript definitions" |
|||
go get github.com/tkrajina/typescriptify-golang-structs/typescriptify@v0.1.7 |
|||
tscriptify -interface -package=github.com/grafana/grafana/pkg/services/live/pipeline -import="import { FieldConfig } from '@grafana/data'" -target=public/app/features/live/pipeline/models.gen.ts pkg/services/live/pipeline/config.go |
|||
go mod tidy |
|||
|
|||
# This repository's configuration is protected (https://readme.drone.io/signature/).
|
|||
# Use this make target to regenerate the configuration YAML files when
|
|||
# you modify starlark files.
|
|||
drone: $(DRONE) |
|||
$(DRONE) starlark --format |
|||
$(DRONE) lint .drone.yml --trusted |
|||
$(DRONE) --server https://drone.grafana.net sign --save grafana/grafana |
|||
|
|||
help: ## Display this help.
|
|||
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) |
|||
@ -0,0 +1,4 @@ |
|||
Copyright 2014-2021 Grafana Labs |
|||
|
|||
This software is based on Kibana: |
|||
Copyright 2012-2013 Elasticsearch BV |
|||
@ -0,0 +1,33 @@ |
|||
# Plugin development |
|||
|
|||
This document is not meant as a complete guide for developing plugins but more as a changelog for changes in |
|||
Grafana that can impact plugin development. Whenever you as a plugin author encounter an issue with your plugin after |
|||
upgrading Grafana please check here before creating an issue. |
|||
|
|||
## Plugin development resources |
|||
|
|||
- [Grafana plugin developer guide](https://grafana.com/docs/grafana/latest/developers/plugins/) |
|||
- [Webpack Grafana plugin template project](https://github.com/CorpGlory/grafana-plugin-template-webpack) |
|||
- [Simple JSON datasource plugin](https://github.com/grafana/simple-json-datasource) |
|||
|
|||
## Changes in Grafana v4.6 |
|||
|
|||
This version of Grafana has big changes that will impact a limited set of plugins. We moved from systemjs to webpack |
|||
for built-in plugins and everything internal. External plugins still use systemjs but now with a limited |
|||
set of Grafana components they can import. Plugins can depend on libs like lodash & moment and internal components |
|||
like before using the same import paths. However since everything in Grafana is no longer accessible, a few plugins could encounter issues when importing a Grafana dependency. |
|||
|
|||
[List of exposed components plugins can import/require](https://github.com/grafana/grafana/blob/main/public/app/features/plugins/plugin_loader.ts#L48) |
|||
|
|||
If you think we missed exposing a crucial lib or Grafana component let us know by opening an issue. |
|||
|
|||
### Deprecated components |
|||
|
|||
The angular directive `<spectrum-picker>` is now deprecated (will still work for a version more) but we recommend plugin authors |
|||
upgrade to new `<color-picker color="ctrl.color" onChange="ctrl.onSparklineColorChange"></color-picker>` |
|||
|
|||
## Changes in Grafana v6.0 |
|||
|
|||
### DashboardSrv.ts |
|||
|
|||
If you utilize [DashboardSrv](https://github.com/grafana/grafana/commit/8574dca081002f36e482b572517d8f05fd44453f#diff-1ab99561f9f6a10e1fafcddc39bc1d65) in your plugin code, `dash` was renamed to `dashboard`. |
|||
@ -0,0 +1,47 @@ |
|||
 |
|||
|
|||
The open-source platform for monitoring and observability. |
|||
|
|||
[](LICENSE) |
|||
[](https://drone.grafana.net/grafana/grafana) |
|||
[](https://goreportcard.com/report/github.com/grafana/grafana) |
|||
|
|||
Grafana allows you to query, visualize, alert on and understand your metrics no matter where they are stored. Create, explore, and share dashboards with your team and foster a data driven culture: |
|||
|
|||
- **Visualize:** Fast and flexible client side graphs with a multitude of options. Panel plugins offer many different ways to visualize metrics and logs. |
|||
- **Dynamic Dashboards:** Create dynamic & reusable dashboards with template variables that appear as dropdowns at the top of the dashboard. |
|||
- **Explore Metrics:** Explore your data through ad-hoc queries and dynamic drilldown. Split view and compare different time ranges, queries and data sources side by side. |
|||
- **Explore Logs:** Experience the magic of switching from metrics to logs with preserved label filters. Quickly search through all your logs or streaming them live. |
|||
- **Alerting:** Visually define alert rules for your most important metrics. Grafana will continuously evaluate and send notifications to systems like Slack, PagerDuty, VictorOps, OpsGenie. |
|||
- **Mixed Data Sources:** Mix different data sources in the same graph! You can specify a data source on a per-query basis. This works for even custom datasources. |
|||
|
|||
## Get started |
|||
|
|||
- [Get Grafana](https://grafana.com/get) |
|||
- [Installation guides](http://docs.grafana.org/installation/) |
|||
|
|||
Unsure if Grafana is for you? Watch Grafana in action on [play.grafana.org](https://play.grafana.org/)! |
|||
|
|||
## Documentation |
|||
|
|||
The Grafana documentation is available at [grafana.com/docs](https://grafana.com/docs/). |
|||
|
|||
## Contributing |
|||
|
|||
If you're interested in contributing to the Grafana project: |
|||
|
|||
- Start by reading the [Contributing guide](https://github.com/grafana/grafana/blob/HEAD/CONTRIBUTING.md). |
|||
- Learn how to set up your local environment, in our [Developer guide](https://github.com/grafana/grafana/blob/HEAD/contribute/developer-guide.md). |
|||
- Explore our [beginner-friendly issues](https://github.com/grafana/grafana/issues?q=is%3Aopen+is%3Aissue+label%3A%22beginner+friendly%22). |
|||
- Look through our [style guide and Storybook](https://developers.grafana.com/ui/latest/index.html). |
|||
|
|||
## Get involved |
|||
|
|||
- Follow [@grafana on Twitter](https://twitter.com/grafana/). |
|||
- Read and subscribe to the [Grafana blog](https://grafana.com/blog/). |
|||
- If you have a specific question, check out our [discussion forums](https://community.grafana.com/). |
|||
- For general discussions, join us on the [official Slack](https://slack.grafana.com) team. |
|||
|
|||
## License |
|||
|
|||
Grafana is distributed under [AGPL-3.0-only](LICENSE). For Apache-2.0 exceptions, see [LICENSING.md](https://github.com/grafana/grafana/blob/HEAD/LICENSING.md). |
|||
@ -0,0 +1,5 @@ |
|||
# Roadmap |
|||
|
|||
The roadmap is a tentative plan for the core development team. Things change constantly as pull requests come in and priorities change, but it will give you an idea of our current vision and plan. |
|||
|
|||
To view the Roadmap, go to the Issues tab on GitHub. There you will find three roadmap issues pinned at the top. |
|||
@ -0,0 +1,20 @@ |
|||
# Reporting security issues |
|||
|
|||
If you think you have found a security vulnerability, please send a report to [security@grafana.com](mailto:security@grafana.com). This address can be used for all of Grafana Labs's open source and commercial products (including but not limited to Grafana, Grafana Cloud, Grafana Enterprise, and grafana.com). We can accept only vulnerability reports at this address. |
|||
|
|||
Please encrypt your message to us; please use our PGP key. The key fingerprint is: |
|||
|
|||
F988 7BEA 027A 049F AE8E 5CAA D125 8932 BE24 C5CA |
|||
|
|||
The key is available from [keyserver.ubuntu.com](https://keyserver.ubuntu.com/pks/lookup?search=0xF9887BEA027A049FAE8E5CAAD1258932BE24C5CA&fingerprint=on&op=index). |
|||
|
|||
Grafana Labs will send you a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance. |
|||
|
|||
**Important:** We ask you to not disclose the vulnerability before it have been fixed and announced, unless you received a response from the Grafana Labs security team that you can do so. |
|||
|
|||
## Security announcements |
|||
|
|||
We maintain a category on the community site called [Security Announcements](https://community.grafana.com/c/support/security-announcements), |
|||
where we will post a summary, remediation, and mitigation details for any patch containing security fixes. |
|||
|
|||
You can also subscribe to email updates to this category if you have a grafana.com account and sign on to the community site or track updates via an [RSS feed](https://community.grafana.com/c/support/security-announcements.rss). |
|||
@ -0,0 +1,13 @@ |
|||
# Get Grafana help |
|||
|
|||
--- |
|||
|
|||
First, check the official [Grafana documentation](https://grafana.com/docs/). |
|||
|
|||
If you require further help or support then ask a question in the [Grafana community site](https://community.grafana.com/) or [Grafana Slack](http://slack.raintank.io/). You can also search the community site for previously answered questions, in case someone already had your problem and got help. |
|||
|
|||
**Please note:** |
|||
|
|||
- The Grafana project uses GitHub mainly for tracking bugs and feature requests. |
|||
- Do not open an issue just to ask a question. The issue will be closed immediately. |
|||
- Only submit issues for bug reports, feature requests, or enhancements. |
|||
@ -0,0 +1,109 @@ |
|||
# 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 |
|||
|
|||
- Drone |
|||
- `grafana/build-container` |
|||
- Appveyor |
|||
- Dockerfile |
|||
|
|||
## Node.js |
|||
|
|||
- Drone |
|||
- `grafana/build-container` |
|||
- Appveyor |
|||
- Dockerfile |
|||
|
|||
## Go dependencies |
|||
|
|||
The Grafana project uses [Go modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) to manage dependencies on external packages. This requires a working Go environment with version 1.11 or greater installed. |
|||
|
|||
To add or update a new dependency, use the `go get` command: |
|||
|
|||
```bash |
|||
go get example.com/some/module/pkg |
|||
|
|||
# Pick a specific version. |
|||
go get example.com/some/module/pkg@vX.Y.Z |
|||
``` |
|||
|
|||
Tidy up the `go.mod` and `go.sum` files: |
|||
|
|||
```bash |
|||
go mod tidy |
|||
``` |
|||
|
|||
You have to commit the changes to `go.mod` and `go.sum` before submitting the pull request. |
|||
|
|||
To understand what the actual dependencies of `grafana-server` are, one could run it with `-vv` flag. This might produce an output, different from `go.mod` contents and `-vv` option is the source of truth here. It lists the modules _compiled_ into the executable, while `go.mod` lists also test and weak transitive dependencies (modules, used in some package, which is not in use by itself). If you are interested in reporting a vulnerability in a dependency module - please consult `-vv` output, maybe the "dependency" is not a dependency as such. |
|||
|
|||
### Upgrading dependencies |
|||
|
|||
If you need to upgrade a direct or indirect dependency, you can do it like so, $MODULE being the dependency in question: `go get -u $MODULE`. The corresponding entry in go.mod should then have the version you specified; if it's an indirect dependency, the entry should have the `// indirect` comment. Follow this by executing `go mod tidy`, to ensure that go.mod and go.sum are up to date. If the indirect dependency turns out to not be used (transitively) by any of our packages, `go mod tidy` will actually strip it from go.mod. In that case, you can just ignore it since it isn't used in the end. |
|||
|
|||
## Node.js dependencies |
|||
|
|||
Updated using `yarn`. |
|||
|
|||
- `package.json` |
|||
|
|||
## Where to make changes |
|||
|
|||
### Drone |
|||
|
|||
Our CI builds run on Drone. |
|||
|
|||
#### Files |
|||
|
|||
- `.circleci/config.yml`. |
|||
|
|||
#### Dependencies |
|||
|
|||
- nodejs |
|||
- golang |
|||
- grafana/build-container (our custom docker build container) |
|||
|
|||
### grafana/build-container |
|||
|
|||
The main build steps (in Drone) happen using a custom Docker image that comes pre-baked with some of the necessary dependencies. |
|||
|
|||
Link: [grafana/build-container](https://github.com/grafana/grafana/tree/main/scripts/build/ci-build) |
|||
|
|||
#### Dependencies |
|||
|
|||
- fpm |
|||
- nodejs |
|||
- golang |
|||
- crosscompiling (several compilers) |
|||
|
|||
### Appveyor |
|||
|
|||
Main 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. |
|||
@ -0,0 +1,83 @@ |
|||
# Grafana workflow |
|||
|
|||
This document is based on [GOVERNANCE.md](GOVERNANCE.md). We assume good faith and intend to keep all processes as lightweight as possible but as specific as required. In case of disagreements about anything in this document, GOVERNANCE.md applies. |
|||
|
|||
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC2119](http://tools.ietf.org/html/rfc2119). |
|||
|
|||
Git and [GitHub terminology](https://help.github.com/en/github/getting-started-with-github/github-glossary) are used throughout this document. |
|||
|
|||
Team members and their access to repositories is maintained through [GitHub teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams). Team maintainers add and remove team members as outlined in GOVERNANCE.md. |
|||
|
|||
# Code changes |
|||
|
|||
## Proposing changes |
|||
|
|||
Examples of proposed changes are overarching architecture, component design, and specific code or graphical elements. Proposed changes SHOULD cover the big picture and intention, but individual parts SHOULD be split into the smallest possible changes. Changes SHOULD be based on and target the main branch. Depending on size of the proposed change, each change SHOULD be discussed, in increasing order of change size and complexity: |
|||
|
|||
- Directly in a RR (Pull Request) - this MAY be done, but SHOULD not be the common case. |
|||
- Issue |
|||
- Developer mailing list |
|||
- Design document, shared via Google Docs, accessible to at least all team members. |
|||
|
|||
Significant changes MUST be discussed and agreed upon with the relevant subsystem maintainers. |
|||
|
|||
## Merging PRs (Pull Requests) |
|||
|
|||
Depending on the size and complexity of a PR, different requirements MUST be applied. Any team member contributing substantially to a PR MUST NOT count against review requirements. |
|||
Commits MUST be merged into main using PRs. They MUST NOT be merged into main directly. |
|||
|
|||
- Every merge MUST be approved by at least one team member. |
|||
- Non-trivial changes MUST be approved by at least |
|||
- two team members, or |
|||
- one subsystem maintainer. |
|||
- Significant changes MUST be approved by at least |
|||
- two team members, AND |
|||
- the relevant subsystem maintainer. |
|||
|
|||
PRs MUST be [reviewed](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests) and [approved](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/approving-a-pull-request-with-required-reviews) via GitHub’s review system. |
|||
|
|||
- Reviewers MAY write comments if approving |
|||
- Reviewers MUST write comments if rejecting a PR or if requesting changes. |
|||
|
|||
Once a PR is approved as per above, any team member MAY merge the PR. |
|||
|
|||
## Backporting a PR |
|||
|
|||
PRs intended for inclusion in the next PATCH release they must be backported to the release branch. The bot can do this automatically. [Read more on backport PRs](https://github.com/grafana/grafana/blob/main/.github/bot.md). Both the source PR and the backport PR should be assigned to the patch release milestone, unless you are backporting to many releases then it can differ. |
|||
|
|||
Backport PRs are also needed during the beta period to get fixes into the stable release. |
|||
|
|||
# Release workflow |
|||
|
|||
## Branch structure |
|||
|
|||
Grafana uses trunk-based development. |
|||
|
|||
In particular, we found that the following principles match how we work: |
|||
|
|||
- Main and release branches MUST always build without failure. |
|||
- Branches SHOULD be merged often. Larger changes SHOULD be activated with feature flags until they are ready. Long-lived development branches SHOULD be avoided. |
|||
- Changes MAY be enabled by default once they are in a complete state |
|||
- Changes which span multiple PRs MUST be described in an overarching issue or Google Doc. |
|||
|
|||
## Releases |
|||
|
|||
Releases MUST follow [Semantic Versioning](https://semver.org/) in naming and SHOULD follow Semantic Versioning as closely as reasonably possible for non-library software. |
|||
|
|||
Release branches MUST be split from the following branches. |
|||
|
|||
- MAJOR release branches MUST be based on main. |
|||
- MINOR release branches MUST be based on main. |
|||
- PATCH release branches MUST be split from the relevant MINOR release branch’s most current PATCH |
|||
|
|||
Security releases follow the same process but MUST be prepared in secret. Security releases MUST NOT include changes which are not related to the security fix. Normal release processes MUST accommodate the security release process. SECURITY.md MUST be followed. |
|||
|
|||
Releases follow the following cadence |
|||
|
|||
- MAJOR: Yearly |
|||
- MINOR: Every 4-6 weeks |
|||
- PATCH: As needed |
|||
|
|||
Releases SHOULD NOT be delayed by pending changes. |
|||
|
|||
Releases MUST be coordinated with the relevant subsystem maintainers. |
|||
@ -0,0 +1,38 @@ |
|||
{ |
|||
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", |
|||
"mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts", |
|||
"bundledPackages": [], |
|||
"compiler": {}, |
|||
"apiReport": { |
|||
"enabled": false |
|||
}, |
|||
"docModel": { |
|||
"enabled": true, |
|||
"apiJsonFilePath": "<projectFolder>/../../reports/docs/<unscopedPackageName>.api.json" |
|||
}, |
|||
"dtsRollup": { |
|||
"enabled": false |
|||
}, |
|||
"tsdocMetadata": {}, |
|||
"messages": { |
|||
"compilerMessageReporting": { |
|||
"default": { |
|||
"logLevel": "warning" |
|||
} |
|||
}, |
|||
"extractorMessageReporting": { |
|||
"default": { |
|||
"logLevel": "warning" |
|||
}, |
|||
"ae-internal-missing-underscore": { |
|||
"logLevel": "none", |
|||
"addToApiReportFile": false |
|||
} |
|||
}, |
|||
"tsdocMessageReporting": { |
|||
"default": { |
|||
"logLevel": "warning" |
|||
} |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,59 @@ |
|||
{ |
|||
"babelrc": false, |
|||
// Note: order is bottom-to-top and/or right-to-left |
|||
"presets": [ |
|||
[ |
|||
"@babel/preset-env", |
|||
{ |
|||
"bugfixes": true, |
|||
"browserslistEnv": "dev", |
|||
"useBuiltIns": "entry", |
|||
"corejs": "3.10" |
|||
} |
|||
], |
|||
[ |
|||
"@babel/preset-typescript", |
|||
{ |
|||
"allowNamespaces": true, |
|||
"allowDeclareFields": true |
|||
} |
|||
], |
|||
[ |
|||
"@babel/preset-react", |
|||
{ |
|||
"runtime": "automatic" |
|||
} |
|||
] |
|||
], |
|||
"plugins": [ |
|||
[ |
|||
"@babel/plugin-transform-typescript", |
|||
{ |
|||
"allowNamespaces": true, |
|||
"allowDeclareFields": true |
|||
} |
|||
], |
|||
["@babel/plugin-proposal-object-rest-spread", { "loose": true }], |
|||
"@babel/plugin-transform-react-constant-elements", |
|||
"@babel/plugin-proposal-nullish-coalescing-operator", |
|||
"@babel/plugin-proposal-optional-chaining", |
|||
"@babel/plugin-syntax-dynamic-import", // needed for `() => import()` in routes.ts |
|||
"angularjs-annotate", |
|||
"macros" |
|||
], |
|||
"env": { |
|||
"production": { |
|||
"presets": [ |
|||
[ |
|||
"@babel/preset-env", |
|||
{ |
|||
"browserslistEnv": "production" |
|||
} |
|||
] |
|||
] |
|||
}, |
|||
"hot": { |
|||
"plugins": ["react-refresh/babel"] |
|||
} |
|||
} |
|||
} |
|||
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue