diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0a15365..52190ec 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -98,8 +98,8 @@ jobs: uses: softprops/action-gh-release@v1 with: prerelease: true - name: review - tag_name: review + name: nightly + tag_name: nightly files: | mahendrapaipuri-dashboardreporter-app.zip mahendrapaipuri-dashboardreporter-app.zip.sha1 @@ -108,4 +108,4 @@ jobs: # Latest Build Complete! :rocket: For the public download links of these build artifacts, please see: - + diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index e9ebe23..14ab859 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -15,4 +15,4 @@ jobs: - uses: actions/checkout@v3 - uses: grafana/plugin-actions/build-plugin@release with: - policy_token: ${{ secrets.GRAFANA_ACCESS_POLICY_TOKEN }} # Requires a Grafana access policy token from Grafana.com. + policy_token: '' # We cannot sign plugin as it will not be published in grafana catalog diff --git a/scripts/bootstrap-dashboard-reporter-app.sh b/scripts/bootstrap-dashboard-reporter-app.sh index cc27612..615f010 100644 --- a/scripts/bootstrap-dashboard-reporter-app.sh +++ b/scripts/bootstrap-dashboard-reporter-app.sh @@ -24,5 +24,5 @@ fi echo "The latest release tag of $REPO_NAME is: $LATEST_RELEASE_TAG" -curl -L https://github.com/mahendrapaipuri/grafana-dashboard-reporter-app/releases/download/$LATEST_RELEASE_TAG/influxdata-flightsql-datasource-$VERSION.zip --output dashboard-reporter-app.zip -unzip dashboard-reporter-app.zip -d . +curl -L https://github.com/mahendrapaipuri/grafana-dashboard-reporter-app/releases/download/$LATEST_RELEASE_TAG/mahendrapaipuri-dashboardreporter-app.zip --output mahendrapaipuri-dashboardreporter-app.zip +unzip mahendrapaipuri-dashboardreporter-app.zip -d . diff --git a/src/README.md b/src/README.md index d1a02dc..025bd11 100755 --- a/src/README.md +++ b/src/README.md @@ -24,7 +24,18 @@ panels into PNG files ### Installation via `grafana-cli` -TODO +Grafana Enterprise offers a very similar plugin [reports](https://grafana.com/docs/grafana/latest/dashboards/create-reports/#export-dashboard-as-pdf) +and hence, their plugin policies do not allow to publish the current plugin in their +official catalog. + +It is important to note that the current plugin do not offer all the functionalities +offered by Enterprise plugin and it is only relevant if users would like to create a +PDF report of a given dashboard. If users needs more advanced functionalities like +generating and sending reports automatically, they should look into official plugin. + +However, it is still possible to install this plugin on on-premise Grafana installations +as an unsigned plugin. The installation procedure is briefed in +[Local installation](#local-installation) section below. ### Local installation @@ -39,9 +50,12 @@ plugin directory: ``` cd /var/lib/grafana/plugins -./scripts/bootstrap-dashboard-reporter-app.sh +curl https://raw.githubusercontent.com/mahendrapaipuri/grafana-dashboard-reporter-app/grafana_labs_review/scripts/bootstrap-dashboard-reporter-app.sh | bash ``` +This will install the plugin in the `/var/lib/grafana/plugins` folder and upon Grafana +restart, the plugin will be loaded. + The current example assumes the following configuration is set for Grafana - Edit the `paths.plugins` directive in your `grafana.ini`: @@ -75,7 +89,7 @@ want to create a PDF report. After the user authenticates with Grafana, creating dashboard report is done by visiting the following end point ``` -/api/plugins/dashboard-reporter-app/resources/api?dashUid= +/api/plugins/mahendrapaipuri-reporter-app/resources/api?dashUid= ``` In addition to `dashUid` query parameter, it is possible to pass time range query