Skip to content

Commit

Permalink
feat: v1.0.1 (#1)
Browse files Browse the repository at this point in the history
* feat: v1.0.1

* correct readme
  • Loading branch information
withdave authored Aug 17, 2023
1 parent 64f4e32 commit f75b89d
Show file tree
Hide file tree
Showing 13 changed files with 218 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# by default, require qlik-cloud-monitoring-apps
* @qlik-oss/qlik-cloud-monitoring-apps
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/repo_bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: 🐛 Bug Report
about: Something isn't working as expected
---

## 🐛 Bug report

(A clear and concise description of what the bug is.)

### Steps to Reproduce

1. (Step one)
1. (Step two)
1. ...

### Expected behavior

(A clear and concise description of what you expected to happen.)

### Actual behavior

(A clear and concise description of what actually happened.)

### Additional context

(Add any other context, link to demo or screenshots about the issue.)
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/repo_feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: 🚀 Feature or Improvement
about: Suggest an idea for a new feature or improvement
---

## 🚀 Feature

(A clear and concise description of what the feature/improvement is.)

### Motivation

(A clear and concise description of why this feature/improvement should be added.)

### Additional context

(Add any other context about the feature/improvement request.)
55 changes: 55 additions & 0 deletions .github/workflows/draft_release_on_main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Build a draft release

on:
push:
branches: [ "main" ]

workflow_dispatch:

jobs:
create-release:
runs-on: ubuntu-latest
permissions:
contents: write

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Retrieve version from VERSION
run: |
RELVER=$(cat VERSION | tr -d '[:space:]')
echo "RELVER=$RELVER" >> $GITHUB_ENV
- name: Retrieve app name from APPNAME
run: |
APPNAME=$(cat APPNAME)
echo "APPNAME=$APPNAME" >> $GITHUB_ENV
- name: Draft a release
uses: softprops/action-gh-release@v1
with:
name: ${{ env.RELVER }}
body: |
**!Important - review then remove this top section**
- [ ] Verify the .pdf and .qvf are correct (only the OEM-Dashboard qvf will be automatically attached)
- [ ] Align the tag to the release version
- [ ] Verify release name matches tag (e.g. v1.2.1)
- [ ] Add any comments on breaking changes/ amends to the auto generated release notes
- [ ] Delete this section
We are pleased to release version ${{ env.RELVER }} of the ${{ env.APPNAME }}.
Find attached the app (${{ env.APPNAME }}.qvf and Console-Settings-Collector.qvf) and install guide (OEM-Dashboard-Configuration-Guide.pdf).
draft: true
tag_name: ${{ env.RELVER }}
generate_release_notes: true
fail_on_unmatched_files: true
files: |
./app/${{ env.APPNAME }}.qvf
./app/Console-Settings-Collector.qvf
./docs/OEM-Dashboard-Configuration-Guide.pdf
55 changes: 55 additions & 0 deletions .github/workflows/pr_verify.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Add verification message to pull requests

on:
pull_request:
types: [opened, synchronize, edited, ready_for_review]
branches: [ "main" ]

workflow_dispatch:

jobs:
verify:
runs-on: ubuntu-latest
permissions: write-all

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Retrieve version from VERSION
run: |
RELVER=$(cat VERSION | tr -d '[:space:]')
echo "RELVER=$RELVER" >> $GITHUB_ENV
- name: Retrieve app name from APPNAME
run: |
APPNAME=$(cat APPNAME)
echo "APPNAME=$APPNAME" >> $GITHUB_ENV
- name: PR comment with file
uses: thollander/actions-comment-pull-request@v2
with:
mode: upsert
comment_tag: previewComment
message: |
# PR checklist
Checklist:
- [ ] Is this release [${{ env.RELVER }}] of ${{ env.APPNAME }} and Console Settings Collector?
- [ ] Have you updated `app/${{ env.APPNAME }}.qvf` and/or `Console-Settings-Collector.qvf`?
- [ ] Have you updated the install guide for these apps?
If you wish to merge:
- Have this PR approved by a code owner
- Merge this PR into main
- Go to releases, an action will generate a draft release with docs + attached QVF
- Make any updates, then submit the release
Common issues:
- Version number missing or incorrect (./VERSION file needs updating)
- After merging, draft release doesn't update - this is usually because
the action failed due to an old draft release with the same name.
Delete the draft release, and re-run the action.
1 change: 1 addition & 0 deletions APPNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
OEM-Dashboard
58 changes: 56 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,56 @@
# qlik-cloud-oem-dashboard
The OEM Dashboard is a Qlik Sense application built for Qlik Cloud, which provides a view of your multitenant estate.
> **Warning**
> This application is _community supported_. This means that you should not contact
> Qlik Support for help with this app. See below for additional information
> on how to raise issues on this repository to ask for help.
# Qlik Cloud OEM Dashboard & Console Settings Collector

> **Note**
> This application is one of a set of community built and supported monitoring apps for Qlik Cloud.
> For links to all monitoring apps, visit the [Qlik Cloud Monitoring Apps](https://github.com/qlik-oss/qlik-cloud-monitoring-apps) repository.
The OEM Dashboard is a Qlik Sense application for Qlik Cloud designed for OEM
partners to centrally monitor usage data across their customers’ tenants. It
provides a single pane to review numerous dimensions and measures, compare trends,
and quickly spot issues across many different areas.

Although this dashboard is designed for OEMs, it can also be used by partners and
customers who manage more than one tenant in Qlik Cloud.

![Sheets in the OEM Dashboard](/images/readme_sheets.png)

This application pulls data from the App Analyzer, Entitlement Analyzer, and
the Reload Analyzer, all of which are other monitoring applications for Qlik Cloud.
By bringing this data together, it simplifies and streamlines management of an
OEM environment.

For more information on Qlik’s differentiating multi-tenant approach, please
review [this video](https://www.qlik.com/blog/extending-the-power-of-qlik-sense-saas-for-oem-partners).

The OEM Dashboard is provided with an optional data source, the Console Settings
Collector application, which collects configuration information from each tenant.

## Installing/ updating

A PDF containing installation instructions is attached to each [release](/../../releases).

## Support policy

This app is provided as-is and is not supported by Qlik. Over time, the APIs and
metrics used by the app may change, so it is advised to monitor this repository
for updates, and to update the app promptly when new versions are available.

If you have issues while using this app, support is provided on a best-efforts
basis by contributors to this project.

If you have an issue:

* Review the FAQ section in this readme to see if your issue is a common one
* Review open and closed [issues](/../../issues)
* Open a [new issue](/../../issues/new), following the issue template

If you are able to resolve the issue, then close your issue with the resolution,
and if you feel inclined, open a PR with your proposed changes so that we can
consider including the improvement in the next release of the app.

Thank you for your support!
1 change: 1 addition & 0 deletions VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v1.0.1
Binary file added app/Console-Settings-Collector.qvf
Binary file not shown.
Binary file added app/OEM-Dashboard.qvf
Binary file not shown.
Binary file added docs/OEM-Dashboard-Configuration-Guide.pdf
Binary file not shown.
Binary file added images/readme_sheets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions renovate.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"local>qlik-oss/renovate-config"
]
}

0 comments on commit f75b89d

Please sign in to comment.