From 461cdb317b1dae9bf691923fdcda0f9198b066a6 Mon Sep 17 00:00:00 2001 From: Zhongnan Su Date: Mon, 14 Dec 2020 15:05:07 -0800 Subject: [PATCH] Add codecov for kibana reports & Add README badges (#248) --- .../workflows/kibana-reports-test-and-build-workflow.yml | 7 ++++++- README.md | 6 ++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/.github/workflows/kibana-reports-test-and-build-workflow.yml b/.github/workflows/kibana-reports-test-and-build-workflow.yml index f39f2525..3bb0e4d9 100644 --- a/.github/workflows/kibana-reports-test-and-build-workflow.yml +++ b/.github/workflows/kibana-reports-test-and-build-workflow.yml @@ -48,7 +48,12 @@ jobs: with: timeout_minutes: 30 max_attempts: 3 - command: cd kibana/plugins/${{ env.PLUGIN_NAME }}; yarn test + command: cd kibana/plugins/${{ env.PLUGIN_NAME }}; yarn test --coverage + + - name: Uploads coverage + uses: codecov/codecov-action@v1 + with: + token: ${{ secrets.CODECOV_TOKEN }} - name: Build Artifact run: | diff --git a/README.md b/README.md index 0d2003f9..171471a9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ +[![Kibana Reports CI](https://github.com/opendistro-for-elasticsearch/kibana-reports/workflows/Test%20and%20Build%20Kibana%20Reports/badge.svg)](https://github.com/opendistro-for-elasticsearch/kibana-reports/actions?query=workflow%3A%22Test+and+Build+Kibana+Reports%22) +[![Reports Scheduler CI](https://github.com/opendistro-for-elasticsearch/kibana-reports/workflows/Test%20and%20Build%20Reports%20Scheduler/badge.svg)](https://github.com/opendistro-for-elasticsearch/kibana-reports/actions?query=workflow%3A%22Test+and+Build+Reports+Scheduler%22) +[![codecov](https://codecov.io/gh/opendistro-for-elasticsearch/kibana-reports/branch/master/graph/badge.svg?token=FBVYQSZD3B)](https://codecov.io/gh/opendistro-for-elasticsearch/kibana-reports) +[![Documentation](https://img.shields.io/badge/documentation-blue.svg)](https://opendistro.github.io/for-elasticsearch-docs/docs/kibana/reporting/) +![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success) + # Kibana Reports for Open Distro Kibana Reports for Open Distro allows ‘Report Owner’ (engineers, including but not limited to developers, DevOps, IT Engineer, and IT admin) export and share reports from Kibana dashboards, saved search, alerts and visualizations. It helps automate the process of scheduling reports on an on-demand or a periodical basis (on cron schedules as well). Further, it also automates the process of exporting and sharing reports triggered for various alerts. The feature is present in the Dashboard, Discover, and Visualization tabs. Scheduled reports can be sent to (shared with) self or various stakeholders within the organization such as, including but not limited to, executives, managers, engineers (developers, DevOps, IT Engineer) in the form of pdf, hyperlinks, csv, excel via various channels such as email, slack, Amazon Chime. However, in order to export, schedule and share reports, report owners should have the necessary permissions as defined under Roles and Privileges.