feat: implement handling duplicate dashboards in same folder (#50)

* fix: handle duplicates when overite is set to true
* use title instead of slug
* add test cases
* add github pr/release actions
* add pr template
* update pr checker
* add overwrite args and help
* rename to grafyaml for consistency
* implement overwrite arg
* use overwrite as default state
* improve render script
* add pagination to search db

Author: nyambati

.github/pull_request_template.md

@@ -0,0 +1,25 @@
+## Description
+
+_A concise summary of the changes._
+
+## Why?
+
+_The reason for this change._
+
+## How?
+
+_A brief explanation of how the changes were implemented._
+
+## Checklist
+
+- [ ] I have performed a self-review of my own code
+- [ ] I have added or updated relevant tests
+- [ ] I have updated the documentation (if necessary)
+
+## Type of change
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Other (please specify):

.github/workflows/.releaserc.json

@@ -0,0 +1,11 @@
+{
+  "verifyConditions": ["@semantic-release/changelog", "@semantic-release/git"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    "@semantic-release/git",
+    "@semantic-release/github"
+  ],
+  "branches": ["+([0-9])?(.{+([0-9]),x}).x", "master"]
+}

.github/workflows/pull_request_check.yaml

@@ -0,0 +1,31 @@
+name: PR checker
+
+on:
+  pull_request:
+    branches: [master, main]
+    types: [opened, edited, labeled, unlabeled, synchronize]
+
+jobs:
+  pr-checker:
+    name: Validate pull request
+    runs-on: [ubuntu-latest]
+    steps:
+      - name: Run check
+        uses: transferwise/actions-pr-checker@v3
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_TITLE_CONTAINS_PATTERN: "^(chore|fix|feat): .*"
+          PR_COMMENT: |
+            The title of your PR does not match the expected format. It **must** always contain the following types: chore, fix, feat, docs, style, refactor or test.
+
+            ✅ Correct examples:
+            * chore: my cool PR
+            * chore: #1234, #1234: chore with issue number
+            * fix: my cool bugfix
+            * fix: #1234, #1234: fix with issue number
+            * feat: my cool bugfix
+            * feat: #1234, #1234: with issue number
+
+            ❌ Wrong examples:
+            * My cool feature
+            * WAL-0 my cool feature

.github/workflows/release.yaml

@@ -0,0 +1,44 @@
+name: Semantic Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  semantic-release:
+    name: Semantic Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "lts/*"
+
+      - name: Semantic Release
+        uses: cycjimmy/semantic-release-action@v2
+        id: semantic # Need an `id` for output variables
+        with:
+          semantic_version: 17
+          extra_plugins: |
+            @semantic-release/changelog@5
+            @semantic-release/exec@5
+            @semantic-release/git@9
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Do something when a new release published
+        if: steps.semantic.outputs.new_release_published == 'true'
+        run: |
+          echo ${{ steps.semantic.outputs.new_release_version }}
+          echo ${{ steps.semantic.outputs.new_release_major_version }}
+          echo ${{ steps.semantic.outputs.new_release_minor_version }}
+          echo ${{ steps.semantic.outputs.new_release_patch_version }}

.gitignore

@@ -18,4 +18,6 @@ __pycache__
 examples/advanced/rendered_dashboards/*.yaml
 
 /venv3
-.venv/
+*venv/
+*vscode/
+*conf

Dockerfile

@@ -28,4 +28,4 @@ RUN /output/install-from-bindep
 # may optionally supply GRAFANA_APIKEY.
 # Mount the dashboards at /grafana.
 
-ENTRYPOINT /usr/local/bin/grafana-dashboard --debug --grafana-url="${GRAFANA_URL}" ${GRAFANA_APIKEY:+--grafana-apikey "$GRAFANA_APIKEY"} update /grafana
+ENTRYPOINT /usr/local/bin/grafyaml --debug --grafana-url="${GRAFANA_URL}" ${GRAFANA_APIKEY:+--grafana-apikey "$GRAFANA_APIKEY"} update /grafana

README.md

@@ -35,7 +35,7 @@ Sync it to Grafana:
 
 ```
 export GRAFANA_API_KEY="API_KEY_HERE"
-grafana-dashboard --grafana-url https://my-grafana-host.domain.com update my-example-dashboard.yaml
+grafyaml --grafana-url https://my-grafana-host.domain.com update my-example-dashboard.yaml
 ```
 
 ## More examples