feat: ✨ add github runner files

Author: tomgrv

.artifacts/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

.github/workflows/build-spk.yml

@@ -0,0 +1,54 @@
+# @format
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build-spk:
+    name: Build Package
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      max-parallel: 1
+      matrix:
+        dsm: ['7.0']
+        arch: ['avoton']
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Build Package
+        uses: tomgrv/synology-package-builder@v1
+        with:
+          dsm: ${{ matrix.dsm }}
+          arch: ${{ matrix.arch }}
+          output: ./dist
+
+      - name: Upload Package
+        uses: actions/upload-artifact@v4
+        with:
+          name: packages-${{ matrix.dsm }}-${{ matrix.arch }}
+          path: ./dist/*.spk
+
+  create-release:
+    name: Create Release
+    runs-on: ubuntu-latest
+    needs: build-spk
+    if: startsWith(github.ref, 'refs/tags/')
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Download Package Artifact
+        uses: actions/download-artifact@v4
+        with:
+          path: ./dist
+      - name: Create Release
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: ./dist/*.spk
+          draft: false
+          prerelease: false

.github/workflows/package.yml

@@ -19,3 +19,4 @@
 bin
 obj
 ./.gitattributes
+.github/workflows/.secrets

.gitignore

@@ -0,0 +1,3 @@
+major-version-bump-message: "^(build|ci|docs|feat|fix|perf|refactor|revert|style|test)(\\([\\w\\s-]*\\))?(!:|:.*\\n\\n((.+\\n)+\\n)?BREAKING CHANGE:\\s.+)"
+minor-version-bump-message: "^(feat)(\\([\\w\\s-]*\\))?:"
+patch-version-bump-message: "^(build|ci|docs|fix|perf|refactor|revert|style|test)(\\([\\w\\s-]*\\))?:"

.gitversion

@@ -1,4 +1,7 @@
 {
+    "\"workbench": {
+        "colorCustomizations\"": null
+    },
     "workbench.colorCustomizations": {
         "titleBar.activeBackground": "#f4d22a",
         "titleBar.border": "#f4d22a",
@@ -9,4 +12,4 @@
         "activityBar.foreground": "#16784f",
         "activityBar.inactiveForeground": "#12603f"
     }
-}
+}

.vscode/settings.json

@@ -1 +1,36 @@
-# gh-runner-synology
+<!-- @format -->
+
+# Github Runner Synology Package
+
+## Description
+
+This package allows you to run GitHub Actions on your Synology NAS. It uses the [myoung34/github-runner](https://github.com/myoung34/docker-github-actions-runner) GitHub Runner Docker image to execute workflows.
+
+## Installation
+
+1. Download the package from the [Releases](https://github.com/tomgrv/github-runner-synology/releases) page.
+
+2. Open the Synology Package Center.
+
+3. Click on "Manual Install" and select the downloaded `.spk` file.
+
+4. Follow the installation instructions.
+
+> The package will go in error state initially, but this is expected as it needs to be elevated to run properly.
+
+5. Elevate the package by following the instructions in the [Elevate Package](https://github.com/tomgrv/synology-package-builder/blob/main/doc/elevated.md)
+
+6. After elevation, the package will:
+    - Download the docker image
+    - Create a Docker container in the Container Manager
+    - Start the GitHub Runner as configured.
+
+## Credits
+
+This package is based on the work of [myoung34](https://github.com/myoung34)
+
+This package was created using the [Synology Package Builder Github Action](https://github.com/marketplace/actions/synology-package-builder-github-action).
+
+## License
+
+This package is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

README.md

@@ -1,6 +1,10 @@
 {
+    "name": "github-runner",
+    "version": "2.325.0+1.0.0",
+    "description": "Run GitHub Actions jobs on your Synology NAS using myoung34/github-runner docker image.",
+    "license": "MIT",
     "scripts": {
-        "lint": "npx --yes lint-staged -p false",
+        "lint": "npx --yes lint -staged -p false",
         "release": "npx --yes commit-and-tag-version --no-verify --"
     },
     "config": {
@@ -119,5 +123,15 @@
         "*.{js,jsx,ts,tsx,md,html,css,vue,yaml,yml}": [
             "npx --yes prettier --write"
         ]
-    }
+    },
+    "synology": {
+        "displayname": "Github Runner",
+        "distributor": "tomgrv/synology-github-runner",
+        "distributor_url": "https://github.com/tomgrv/synology-github-runner",
+        "maintainer": "myoung34/docker-github-actions-runner",
+        "maintainer_url": "https://github.com/myoung34/docker-github-actions-runner",
+        "os_min_ver": "7.0-40337",
+        "support_url": "https://github.com/tomgrv/synology-github-runner/issues"
+    },
+    "target": "./src"
 }