mirror of
https://github.com/grafana/grafana.git
synced 2025-07-28 14:12:09 +08:00
f98ad926ac
* Add Grafana tutorials originally from tutorials repository Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Replace tutorials/step shortcode with ordinary headings Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix typos reported by codespell Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix doc-validator linting and run prettier Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
78 lines
2.3 KiB
Markdown
78 lines
2.3 KiB
Markdown
---
|
|
title: Package your plugin
|
|
---
|
|
|
|
Once you're happy with your plugin, it's time to package it, and submit to the plugin repository.
|
|
|
|
For users to be able to use the plugin without building it themselves, you need to make a production build of the plugin, and commit to a release branch in your repository.
|
|
|
|
To submit a plugin to the plugin repository, you need to create a release of your plugin. While we recommend following the branching strategy outlined below, you're free to use one that makes more sense to you.
|
|
|
|
#### Create a plugin release
|
|
|
|
Let's create version 0.1.0 of our plugin.
|
|
|
|
1. Create a branch called `release-0.1.x`.
|
|
|
|
```
|
|
git checkout -b release-0.1.x
|
|
```
|
|
|
|
1. Do a production build.
|
|
|
|
```
|
|
yarn build
|
|
```
|
|
|
|
1. Add the `dist` directory.
|
|
|
|
```
|
|
git add -f dist
|
|
```
|
|
|
|
1. Create the release commit.
|
|
|
|
```
|
|
git commit -m "Release v0.1.0"
|
|
```
|
|
|
|
1. Create a release tag.
|
|
|
|
```
|
|
git tag -a v0.1.0 -m "Create release tag v0.1.0"
|
|
```
|
|
|
|
1. Push to GitHub. `follow-tags` tells Git to push the release tag along with our release branch.
|
|
```
|
|
git push --set-upstream origin release-0.1.x --follow-tags
|
|
```
|
|
|
|
#### Submit the plugin
|
|
|
|
For a plugin to be published on [Grafana Plugins](/grafana/plugins/), it needs to be added to the [grafana-plugin-repository](https://github.com/grafana/grafana-plugin-repository).
|
|
|
|
1. Fork the [grafana-plugin-repository](https://github.com/grafana/grafana-plugin-repository)
|
|
|
|
1. Add your plugin to the `repo.json` file in the project root directory:
|
|
|
|
```json
|
|
{
|
|
"id": "<plugin id>",
|
|
"type": "<plugin type>",
|
|
"url": "https://github.com/<username>/my-plugin",
|
|
"versions": [
|
|
{
|
|
"version": "<version>",
|
|
"commit": "<git sha>",
|
|
"url": "https://github.com/<username>/my-plugin"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
1. [Create a pull request](https://github.com/grafana/grafana-plugin-repository/pull/new/master).
|
|
|
|
Once your plugin has been accepted, it'll be published on [Grafana Plugin](/grafana/plugins/), available for anyone to [install](/docs/grafana/latest/plugins/installation/)!
|
|
|
|
> We're auditing every plugin that's added to make sure it's ready to be published. This means that it might take some time before your plugin is accepted. We're working on adding more automated tests to improve this process.
|