Merge pull request #2 from byrdsandbytes/feature/build-workflow

Feature/build workflow

Author: Idrimi

.github/workflows/build.yml

@@ -0,0 +1,54 @@
+name: Build and Test
+
+on:
+  push:
+    branches: [ main ]
+    paths-ignore:
+      - '*.md'
+      - 'docs/**'
+  pull_request:
+    branches: [ main ]
+    paths-ignore:
+      - '*.md'
+      - 'docs/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    
+    strategy:
+      matrix:
+        node-version: [22.x]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Setup Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Run linting
+      run: npm run lint --if-present
+
+    - name: Run tests
+      run: npm test --if-present
+
+    - name: Build project
+      run: npm run build
+
+    - name: Check TypeScript compilation
+      run: npx tsc --noEmit
+
+    - name: Upload build artifacts
+      if: matrix.node-version == '22.x'
+      uses: actions/upload-artifact@v4
+      with:
+        name: dist-files
+        path: dist/
+        retention-days: 30

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: Install Test
+
+on:
+  schedule:
+    # Test installation weekly to ensure it works from GitHub
+    - cron: '0 0 * * 0'
+  workflow_dispatch:
+
+jobs:
+  install-test:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Create test project
+      run: |
+        mkdir test-install
+        cd test-install
+        npm init -y
+        
+    - name: Test installation from GitHub
+      run: |
+        cd test-install
+        npm install byrdsandbytes/capacitor-zeroconf
+        
+    - name: Verify package can be imported
+      run: |
+        cd test-install
+        node -e "
+          try {
+            const { ZeroConf } = require('capacitor-zeroconf');
+            console.log('✅ Package imported successfully');
+            console.log('ZeroConf plugin:', typeof ZeroConf);
+          } catch (error) {
+            console.error('❌ Failed to import:', error.message);
+            process.exit(1);
+          }
+        "

.github/workflows/release.yml

@@ -0,0 +1,60 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    
+    permissions:
+      contents: write
+      
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '22.x'
+        cache: 'npm'
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Build project
+      run: npm run build
+
+    - name: Run tests
+      run: npm test --if-present
+
+    - name: Create GitHub Release
+      id: create_release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ github.ref }}
+        release_name: Release ${{ github.ref }}
+        body: |
+          See the [README](https://github.com/byrdsandbytes/capacitor-zeroconf/blob/main/README.md) for usage examples.
+        draft: false
+        prerelease: false
+
+    - name: Zip dist folder
+      run: zip -r dist.zip dist/
+
+    - name: Upload build artifacts to release
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: ./dist.zip
+        asset_name: dist.zip
+        asset_content_type: application/zip

.gitignore

@@ -1,4 +1,5 @@
 # node files
+dist
 node_modules
 
 # iOS files

README.md

@@ -37,18 +37,6 @@ yarn add byrdsandbytes/capacitor-zeroconf
 yarn cap sync
 ```
 
-**Note:** If you get TypeScript errors like "Cannot find module 'capacitor-zeroconf'", this means the package wasn't built when installed from GitHub. You can either:
-
-1. **Recommended:** Install a specific release tag:
-   ```bash
-   npm install byrdsandbytes/capacitor-zeroconf#v7.0.0
-   ```
-
-2. **Or** manually build after installation:
-   ```bash
-   cd node_modules/capacitor-zeroconf
-   npm run build
-   ```
 
 ## Quick Start
 
@@ -334,7 +322,9 @@ Actions that can occur during service discovery
 
 Construct a type with a set of properties K of type T
 
-<code>{ [P in K]: T; }</code>
+<code>{
+ [P in K]: T;
+ }</code>
 
 
 #### ZeroConfWatchCallback

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "capacitor-zeroconf",
-  "version": "7.0.0",
+  "version": "7.0.1",
   "description": "Capacitor ZeroConf plugin",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -49,7 +49,8 @@
     "build-electron": "tsc --project electron/tsconfig.json && rollup -c electron/rollup.config.mjs && rimraf ./electron/build",
     "clean": "rimraf ./dist",
     "watch": "tsc --watch",
-    "prepublishOnly": "yarn build"
+    "prepublishOnly": "yarn build",
+    "postinstall": "npm run build"
   },
   "devDependencies": {
     "@capacitor/android": "^7.0.0",

package.json

@@ -1016,6 +1016,11 @@ fs.realpath@^1.0.0:
   resolved "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz"
   integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==
 
+fsevents@~2.3.2:
+  version "2.3.3"
+  resolved "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz"
+  integrity sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==
+
 function-bind@^1.1.1:
   version "1.1.1"
   resolved "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz"