feat: migrate github action definition from docker to node.js

This update replaces the Docker-based GitHub Action with a Node.js-based implementation for better
maintainability and compatibility with our existing JavaScript tooling. It also fixes an issue with
the permissions of the output files from the previous Docker implementation.

- Added pre-commit and commit message linting hooks using Husky.
- Integrated ESLint for code linting.
- Migrated the previous shell script to an ES6 script.
- Action definition switched from `using: docker` to `using: node20`.
- Designed the script to be dependency-free, eliminating the need for compilation or distributing a
  `dist` folder.

Author: jboix

.commitlintrc

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "@commitlint/config-conventional"
+  ]
+}

.editorconfig

@@ -8,5 +8,8 @@ indent_size = 2
 insert_final_newline = true
 trim_trailing_whitespace = true
 
+[*.mjs]
+quote_type = single
+
 [*.md]
 max_line_length = 100

.githooks/commit-msg

@@ -12,8 +12,16 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
 
-      - name: Build Docker image
-        run: docker build -t grafana-sync-action .
+      - name: Install dependencies
+        run: |
+          npm pkg delete scripts.prepare
+          npm ci
+
+      - name: Run JS and linter
+        run: |
+          npm run eslint

.github/workflows/quality.yml

@@ -24,17 +24,13 @@ jobs:
         with:
           node-version: '22'
 
-      - name: Install semantic-release
+      - name: Install dependencies
         run: |
-          npm install -g @semantic-release/[email protected] \
-          @semantic-release/[email protected] \
-          @semantic-release/[email protected] \
-          [email protected] \
-          [email protected]
+          npm pkg delete scripts.prepare
+          npm ci
 
       - name: Release
         id: semantic-release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          npx semantic-release
+        run: npx semantic-release

.github/workflows/release.yml

@@ -1,12 +1,56 @@
-### Intellij ###
-.idea/
-*.iml
-*.iws
-modules.xml
-*.ipr
-cmake-build-*/
-out/
-.idea_modules/
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Parcel cache
+.parcel-cache
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# Generated output
+dist
+coverage
+
+# Intellij
+.idea
 
 # VisualStudioCode
 .vscode-test

.gitignore

@@ -0,0 +1 @@
+npx --no -- commitlint --edit ${1}

.husky/commit-msg

@@ -0,0 +1 @@
+npm run eslint

.husky/pre-commit

@@ -19,74 +19,80 @@ A GitHub Action that automates the process of backing up Grafana dashboards.
 
 - `GRAFANA_URL`: The URL of your Grafana instance.
 - `GRAFANA_API_KEY`: The API key for Grafana authentication.
-- _(Optional)_ `GH_PAT`: A GitHub Personal Access Token with `repo` permissions, needed only if
-  automating PR creation.
 
 3. **Create a workflow file** in `.github/workflows/grafana-backup.yml` with the following content:
 
   ```yaml
   name: Grafana Dashboard Backup
 
   on:
-     schedule:
-       - cron: '0 2 * * *'  # Runs every day at 2 AM UTC
-     workflow_dispatch:  # Allows manual triggering
+    schedule:
+      - cron: '0 2 * * *'
+    workflow_dispatch:
 
   jobs:
-     backup:
-       runs-on: ubuntu-latest
-
-       steps:
-         - name: Checkout repository
-           uses: actions/checkout@v4
-
-         - name: Run Grafana Sync
-           uses: srgssr/grafana-sync-action@v1
-           with:
-              grafana-url: ${{ secrets.GRAFANA_URL }}
-              api-key: ${{ secrets.GRAFANA_API_KEY }}
-              output-dir: dashboards
-
-         - name: Commit and Push Changes
-           run: |
-             git config --global user.name "github-actions[bot]"
-             git config --global user.email "github-actions[bot]@users.noreply.github.com"
-             git add dashboards
-             git commit -m "Automated backup of Grafana dashboards" || echo "No changes to commit"
-             git push
-
-         # (Optional) Create a Pull request using peter-evans/create-pull-request
-         - name: Create Pull Request
-           uses: peter-evans/create-pull-request@v7
-           with:
-             token: ${{ secrets.GH_PAT }}
-             commit-message: "chore: automated Grafana dashboard backup"
-             title: "chore: automated backup of Grafana dashboards"
-             body: "This PR contains the latest Grafana dashboard updates."
-             branch: "backup/grafana-dashboards"
-             delete-branch: true
+    backup:
+      runs-on: ubuntu-latest
+
+      permissions:
+        contents: write
+        pull-requests: write
+
+      steps:
+        - name: Checkout repository
+          uses: actions/checkout@v4
+          with:
+            fetch-depth: 0
+
+        - name: Run Grafana Sync
+          uses: srgssr/[email protected]
+          with:
+            grafana-url: ${{ secrets.GRAFANA_URL }}
+            api-key: ${{ secrets.GRAFANA_API_KEY }}
+            dir: 'dashboards'
+
+        - name: Create Pull Request
+          uses: peter-evans/create-pull-request@v7
+          with:
+            token: ${{ secrets.GITHUB_TOKEN }}
+            add-paths: dashboards
+            commit-message: "chore: automated grafana dashboard backup"
+            committer: "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>"
+            author: "${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com>"
+            signoff: false
+            draft: false
+            delete-branch: true
+            branch: "chore/update-grafana-dashboards"
+            title: "chore: automated backup of grafana dashboards"
+            body: "This pull request contains the latest backup of our Grafana dashboards"
   ```
 
 **Running the Action**
 
-- The action will **automatically run daily at 2 AM UTC** to check for changes.
+- The action will **automatically run daily at 2 AM** to check for changes.
 - You can also **manually trigger** the workflow from the GitHub Actions tab.
 - If changes are detected, it will create a **pull request** containing the updated dashboards.
 
 ## Contributing
 
 Contributions are welcome! If you'd like to contribute, please follow the project's code style and
-linting rules.
+linting rules. Here are some commands to help you get started:
+
+Check your JavaScript code:
+
+```shell
+npm run eslint
+```
 
 All commits must follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
 format to ensure compatibility with our automated release system. A pre-commit hook is available to
 validate commit messages.
 
-You can set up hook to automate these checks before commiting and pushing your changes, to do so
-update the Git hooks path:
+You can set up hook to automate these checks before commiting and pushing your changes. Enable this
+hook by running the `prepare` script:
 
-```bash
-git config core.hooksPath .githooks/
+```shell
+npm run prepare
 ```
 
 Refer to our [Contribution Guide](docs/CONTRIBUTING.md) for more detailed information.