Releasing pipeline

[itsmylife]

E2E testing CI workflow: https://grafana.com/developers/plugin-tools/e2e-test-a-plugin/ci?current-package-manager=yarn
Backend Testing CI workflow: https://github.com/grafana/clickhouse-datasource/blob/main/.github/workflows/run-backend-tests.yml
Access Policy: https://grafana.com/orgs/grafana/access-policies prometheus-amazon-datasource-plugin

How to release a datasource https://docs.google.com/document/d/1jKH397IEjQsUojaBnA_whSkhiAviVGJ6eIVrpomoPLM/edit (this explains with drone.yml but we don't use it.)

Apparently we also need a drone pipeline too: https://github.com/grafana/enterprise-datasources/wiki/New-plugin-publish-process#setup-drone-pipeline
I'll provide that one in a separate PR

What has been done?

• Update current scaffolding:
  • I run npx @grafana/create-plugin@latest update See https://www.npmjs.com/package/@grafana/create-plugin
    • It updates .config folder
    • It updates .vscode folder (some indentation changes)
  • Update required nodejs version in .nvmrc to v20.9.0 like grafana/grafana
  • Remove cypress mock test
  • asd
• Move matchers under src
• Remove playwright-report/index.html from git cache
• Update playwright base URL as 3000
• Remove docker-compose-debug.yml
• Add prometheus service in docker-compose.yml
• Add version in src/plugin.json
• Remove tests-examples
• Remove unnecessary frontend dependencies
• Update sign command since the plugin is still private https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin#sign-a-private-plugin
• Add a simple backend unit test

[itsmylife]

In CI workflow, Build backend job is waiting for e2e workflow to finish. I don't understand why that's happening.

I enabled buildAll and it takes some time. So wait time is normal. I'll make it linux only for the sake of speed. If we need all we can change it back.

[bohandley]

This all makes sense to me. i like the reorganization of the tests and this is much cleaner, testing multiple Grafana versions. AMAZING WORK!!!!! 🚀🚀🚀🚀🚀

[sunker]

Looks good to me. Added a few comments around the e2e setup.

FYI: In case you experience issues connecting to the Grafana instance in your e2e tests, it may be due to an issue in the Docker dev env. See this thread for more info.

[sunker]

Is there any reason not to use the example workflow for backend plugins from the this? If not, I suggest replacing the content of this file entirely with the yarn based example.

Grafana has a GCS bucket for e2e artifacts. If you want to, you can publish the Playwright report as part of CI. Then a link to the report for every e2e session will be added in the github workflow summary (see the bottom of the page for this pr for example).

 - name: Publish report to GCS
        if: ${{ (always() && steps.run-tests.outcome == 'success') || (failure() && steps.run-tests.outcome == 'failure') }}
        uses: grafana/plugin-actions/publish-report@main
        with:
          grafana-version: ${{ matrix.GRAFANA_IMAGE.VERSION }}

Just bear in mind that the published report will be public on the Internet, so don't do this in case you use secrets in your e2e tests.

[itsmylife]

That wasn't working for me so I had to remove it. It was asking for some kind of env variable which I do not have and don't know how to have it. I'd keep the current version for now 'cause it's working. Maybe later I'll replace it. I'll create an issue for this one.

[itsmylife]

Now I am using the suggested one with one addition. docker-compose down