Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

create-plugin: Add provisioning scaffold #529

Merged
merged 47 commits into from
Dec 7, 2023
Merged

create-plugin: Add provisioning scaffold #529

merged 47 commits into from
Dec 7, 2023

Conversation

Ukochka
Copy link
Contributor

@Ukochka Ukochka commented Nov 8, 2023 •
edited by grafana-plugins-platform-bot bot
Loading

What this PR does / why we need it:
To be able to improve plugin review process we need to ask plugin developers to provide provisioning to their plugin. It will save us time to prepare testing environment and it will speed up plugin review process.

This PR consists of the following changes:

  1. Adds new folder 'provisioning' to each plugin type template with examples of provisioning files and README.
  2. Adds option to add provisioning while editing.
    npx @grafana/create-plugin@latest provisioning depending on plugin type
  3. Creates documentation about provisioning

Which issue(s) this PR fixes:
Fixes #497

📦 Published PR as canary version: Canary Versions

✨ Test out this PR locally via:

npm install @grafana/[email protected]
npm install @grafana/[email protected]
# or 
yarn add @grafana/[email protected]
yarn add @grafana/[email protected]

@Ukochka Ukochka self-assigned this Nov 8, 2023
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 8, 2023 •
edited
Loading

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged and will trigger a new minor release.
NOTE: When merging a PR with the release label please avoid merging another PR. For further information see here.

oshirohugo
oshirohugo reviewed Nov 8, 2023
View reviewed changes
Copy link
Contributor

@oshirohugo oshirohugo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work! 🚀
I've left some small suggestions!

packages/create-plugin/src/commands/provisioning.command.ts Outdated Show resolved Hide resolved
docusaurus/docs/create-a-plugin/develop-a-plugin/provide-provisioning.md Outdated Show resolved Hide resolved
@Ukochka Ukochka added release Create a release when this pr is merged minor Increment the minor version when merged labels Nov 8, 2023
oshirohugo
oshirohugo approved these changes Nov 8, 2023
View reviewed changes
Copy link
Contributor

@oshirohugo oshirohugo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!
But as I don't have much experience with plugin-tools I would wait for @academo or @leventebalogh reviews

@sympatheticmoose
Copy link
Contributor

@Ukochka I'd like to take a quick look at this before you merge, I should be able to do so tomorrow 🙏

jackw
jackw previously requested changes Nov 9, 2023
View reviewed changes
Copy link
Collaborator

@jackw jackw left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This repo uses NPM not yarn. I'm sorry for the confusion but it came to my attention that the contributing guides are out of date this morning. Please can you delete the yarn.lock from this PR? It's also preventing publishing the canary release which is really helpful for reviewing these changes.

Update: I've now opened a PR here to help resolve this for future contributors.

jackw and others added 18 commits November 24, 2023 15:44
@jackw @sympatheticmoose @Ukochka
Docs: Fix code block indentations and use titles and tsx (#535)
4fc8849 
Co-authored-by: David Harris <[email protected]>
@sunker @jackw @Ukochka
Plugin E2E workspace prep (#533)
3a3f045 
Co-authored-by: Jack Westbrook <[email protected]>
@sunker @Ukochka
Plugin E2E: Add E2E selectors (#537)
b3f3494
@josmperez @Ukochka
Add code comments on 'Add anonymous usage reporting' topic (#531)
0f34964
@dependabot @Ukochka
Chore(deps): Bump nrwl/nx-set-shas from 3 to 4 (#514)
876bfbd
@dependabot @Ukochka
Chore(deps): Bump @types/semver from 7.5.2 to 7.5.4 (#511)
f47743c
@dependabot @Ukochka
Chore(deps-dev): Bump @auto-it/first-time-contributor from 10.46.0 to…
672afa3 
… 11.0.4 (#513)
@dependabot @Ukochka
Chore(deps): Bump marked from 4.0.12 to 10.0.0 (#540)
d34667f 
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot @mckn @Ukochka
Chore(deps-dev): Bump tsc-watch from 4.6.2 to 6.0.4 (#512)
7c60439 
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Marcus Andersson <[email protected]>
@sunker @Ukochka
Plugin E2E: Add first fixtures (#538)
48e6ca2
@tolzhabayev @Ukochka
should avoid running for dependabot prs (#521)
cc0213d
@josmperez @xnyo @Ukochka
Docs: Add plugin examples folder (#542)
2607253 
Co-authored-by: Giuseppe Guerra <[email protected]>
@sunker @Ukochka
Plugin E2E: Make it possible to test data source config page (#546)
aad8808
@sympatheticmoose @Ukochka
Update index.md (#550)
cb44d23
@leventebalogh @sympatheticmoose
@jackw @josmperez @Ukochka
Docs: Add example for component extensions (#548)
f14034b 
Co-authored-by: David Harris <[email protected]>
Co-authored-by: Jack Westbrook <[email protected]>
Co-authored-by: Joseph Perez <[email protected]>
@sd2k @Ukochka
Mention new alerting extension point PR in docs (#545)
aab9fc7
@josmperez @jackw
@sympatheticmoose @Ukochka
Docs: Replace DocCardLists with DocLinkLists (#526)
b715ef0 
Co-authored-by: Jack Westbrook <[email protected]>
Co-authored-by: David Harris <[email protected]>
@Ukochka
Merge branch 'main' into add-provisioning-scaffold
88d8b09
sympatheticmoose
sympatheticmoose reviewed Dec 4, 2023
View reviewed changes
docusaurus/docs/publish-a-plugin/provide-provisioning.md Outdated Show resolved Hide resolved
docusaurus/docs/publish-a-plugin/provide-provisioning.md Outdated Show resolved Hide resolved
docusaurus/docs/publish-a-plugin/provide-provisioning.md Outdated Show resolved Hide resolved
docusaurus/docs/publish-a-plugin/provide-provisioning.md Outdated Show resolved Hide resolved
docusaurus/docs/publish-a-plugin/publish-or-update-a-plugin.md Outdated Show resolved Hide resolved
docusaurus/docs/publish-a-plugin/publish-or-update-a-plugin.md Outdated Show resolved Hide resolved
packages/create-plugin/templates/app/provisioning/plugins/README.md Outdated Show resolved Hide resolved
packages/create-plugin/templates/scenes-app/provisioning/README.md Outdated Show resolved Hide resolved
packages/create-plugin/templates/datasource/provisioning/README.md Show resolved Hide resolved
sympatheticmoose
sympatheticmoose approved these changes Dec 7, 2023
View reviewed changes
Copy link
Contributor

@sympatheticmoose sympatheticmoose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - lets get this merged 🚀 🙌

@Ukochka Ukochka merged commit 2dfba91 into main Dec 7, 2023
20 checks passed
@Ukochka Ukochka deleted the add-provisioning-scaffold branch December 7, 2023 09:35
@sympatheticmoose sympatheticmoose mentioned this pull request Dec 13, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jackw jackw jackw left review comments

@academo academo academo approved these changes

@josmperez josmperez josmperez approved these changes

@oshirohugo oshirohugo oshirohugo approved these changes

@leventebalogh leventebalogh leventebalogh approved these changes

@sympatheticmoose sympatheticmoose sympatheticmoose approved these changes

Assignees

@Ukochka Ukochka

Labels
minor Increment the minor version when merged release Create a release when this pr is merged
Projects
Plugins Platform / Grafana Community
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add provisioning scaffold
10 participants
@Ukochka @sympatheticmoose @leventebalogh @jackw @academo @oshirohugo @josmperez @sunker @tolzhabayev @sd2k