ci: test ci/cd

robsonos · Dec 6, 2023 · 04eff86 · 04eff86
1 parent b97d8a1
commit 04eff86
Show file tree

Hide file tree

Showing 13 changed files with 2,536 additions and 264 deletions.
diff --git a/.github/workflows/cd.yaml b/.github/workflows/cd.yaml
@@ -0,0 +1,36 @@
+name: Continuous deployment
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  cd:
+    runs-on: macos-12
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for npm provenance
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -0,0 +1,40 @@
+name: Continuous integration
+on:
+  push:
+    branches:
+      - dev
+
+env:
+  JAVA_VERSION: 17
+
+jobs:
+  ci:
+    runs-on: macos-13
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Set up Xcode
+        run: sudo xcode-select --switch /Applications/Xcode_14.2.app
+
+      - name: Setup Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: ${{ env.JAVA_VERSION }}
+          distribution: 'zulu'
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Lint
+        run: yarn lint
+
+      - name: Verify
+        run: yarn verify
diff --git a/.releaserc b/.releaserc
@@ -0,0 +1,24 @@
+{
+  "branches": [
+    "main"
+  ],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    {
+      "path": "@semantic-release/npm",
+      "npmPublish": true,
+      "pkgRoot": "."
+    },
+    {
+      "path": "@semantic-release/git",
+      "assets": [
+        "package.json",
+        "yarn.lock",
+        "CHANGELOG.md"
+      ],
+      "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+    }
+  ]
+}
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -0,0 +1,24 @@
+excluded:
+  - 'node_modules'
+  - 'ios/Pods'
+  - 'example/node_modules'
+  - 'example/ios/App/Pods'
+  - 'example/ios/DerivedData'
+
+opt_in_rules:
+  - 'implicitly_unwrapped_optional'
+  - 'file_name_no_space'
+  - 'force_unwrapping'
+  - 'function_default_parameter_at_end'
+  - 'lower_acl_than_parent'
+  - 'modifier_order'
+  - 'overridden_super_call'
+  - 'unowned_variable_capture'
+  - 'unused_import'
+
+line_length:
+  warning: 150
+  ignores_function_declarations: true
+  ignores_comments: true
+  ignores_interpolated_strings: true
+  ignores_urls: true
diff --git a/README.md b/README.md
@@ -45,14 +45,14 @@ Please check the sample permissions in [Android](./example/android/app/src/main/
 
 <docgen-index>
 
-- [`startDFU(...)`](#startdfu)
-- [`checkPermissions()`](#checkpermissions)
-- [`requestPermissions()`](#requestpermissions)
-- [`addListener('DFUStateChanged', ...)`](#addlistenerdfustatechanged)
-- [`removeAllListeners()`](#removealllisteners)
-- [Interfaces](#interfaces)
-- [Type Aliases](#type-aliases)
-- [Enums](#enums)
+* [`startDFU(...)`](#startdfu)
+* [`checkPermissions()`](#checkpermissions)
+* [`requestPermissions()`](#requestpermissions)
+* [`addListener('DFUStateChanged', ...)`](#addlistenerdfustatechanged)
+* [`removeAllListeners()`](#removealllisteners)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+* [Enums](#enums)
 
 </docgen-index>
 
@@ -78,7 +78,8 @@ Initiates the DFU process with the specified options.
 
 **Since:** 1.0.0
 
----
+--------------------
+
 
 ### checkPermissions()
 
@@ -92,7 +93,8 @@ Check status of permissions needed by the plugin
 
 **Since:** 1.0.0
 
----
+--------------------
+
 
 ### requestPermissions()
 
@@ -106,7 +108,8 @@ Request permissions needed by the plugin
 
 **Since:** 1.0.0
 
----
+--------------------
+
 
 ### addListener('DFUStateChanged', ...)
 
@@ -125,7 +128,8 @@ Listen for when the DFU state changes
 
 **Since:** 1.0.0
 
----
+--------------------
+
 
 ### removeAllListeners()
 
@@ -137,16 +141,19 @@ Removes all listeners for the DFUStateChanged event
 
 **Since:** 1.0.0
 
----
+--------------------
+
 
 ### Interfaces
 
+
 #### PluginResultError
 
 | Prop          | Type                |
 | ------------- | ------------------- |
 | **`message`** | <code>string</code> |
 
+
 #### DfuUpdateOptions
 
 Specifies the options required for initiating the DFU process.
@@ -158,6 +165,7 @@ Specifies the options required for initiating the DFU process.
 | **`filePath`**      | <code>string</code>                               | The path to the firmware file                                                                                                             | 1.0.0 |
 | **`dfuOptions`**    | <code><a href="#dfuoptions">DfuOptions</a></code> | The additional options for the DFU process                                                                                                | 1.0.0 |
 
+
 #### DfuOptions
 
 Outlines additional options for configuring the DFU process.
@@ -182,6 +190,7 @@ Outlines additional options for configuring the DFU process.
 | **`mbrSize`**                                               | <code>number</code>  | This method sets the size of an MBR (Master Boot Record). It should be used only when updating a file from a HEX file. If you use BIN or ZIP, value set here will be ignored.                                                                                                                                                                                                                                                                  | <code>4096</code>  | 1.0.0 |
 | **`unsafeExperimentalButtonlessServiceInSecureDfuEnabled`** | <code>boolean</code> | Set this flag to true to enable experimental buttonless feature in Secure DFU. When the experimental Buttonless DFU Service is found on a device, the service will use it to switch the device to the bootloader mode, connect to it in that mode and proceed with DFU.                                                                                                                                                                        | <code>false</code> | 1.0.0 |
 
+
 #### PermissionStatus
 
 Represents the current status of permissions in the plugin.
@@ -190,12 +199,14 @@ Represents the current status of permissions in the plugin.
 | ------------------- | ----------------------------------------------------------- | ------------------------------------------------ | ----- |
 | **`notifications`** | <code><a href="#permissionstate">PermissionState</a></code> | Indicates the permission state of notifications. | 1.0.0 |
 
+
 #### PluginListenerHandle
 
 | Prop         | Type                                      |
 | ------------ | ----------------------------------------- |
 | **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
 
+
 #### DfuUpdate
 
 The DFU update object that is passed to the DFUStateChanged event
@@ -205,6 +216,7 @@ The DFU update object that is passed to the DFUStateChanged event
 | **`state`** | <code><a href="#dfustate">DfuState</a></code>           | Defines the structure for the DFU update object passed to the DFUStateChanged event. | 1.0.0 |
 | **`data`**  | <code><a href="#dfuupdatedata">DfuUpdateData</a></code> | The DFU data that is passed to the <a href="#dfuupdate">DfuUpdate</a> object         | 1.0.0 |
 
+
 #### DfuUpdateData
 
 Contains data related to the DFU update process, such as progress and speed.
@@ -217,14 +229,18 @@ Contains data related to the DFU update process, such as progress and speed.
 | **`currentPart`** | <code>number</code> | The number of parts being sent. In case the ZIP file contains a Soft Device and/or a Bootloader together with the application the SD+BL are sent as part 1, then the service starts again and send the application as part 2. | 1.0.0 |
 | **`partsTotal`**  | <code>number</code> | The total number of parts.                                                                                                                                                                                                    | 1.0.0 |
 
+
 ### Type Aliases
 
+
 #### PermissionState
 
 <code>'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'</code>
 
+
 ### Enums
 
+
 #### DfuState
 
 | Members                    | Value                               | Description                                                        | Since |

diff --git a/android/src/main/java/com/example/plugin/nordicdfu/NordicDfu.java b/android/src/main/java/com/example/plugin/nordicdfu/NordicDfu.java
@@ -74,12 +74,13 @@ public void onEnablingDfuMode(@NonNull final String deviceAddress) {
 
         @Override
         public void onProgressChanged(
-                @NonNull final String deviceAddress,
-                final int percent,
-                final float speed,
-                final float avgSpeed,
-                final int currentPart,
-                final int partsTotal) {
+            @NonNull final String deviceAddress,
+            final int percent,
+            final float speed,
+            final float avgSpeed,
+            final int currentPart,
+            final int partsTotal
+        ) {
             JSObject ret = new JSObject();
             ret.put("deviceAddress", deviceAddress);
             ret.put("percent", percent);
@@ -116,7 +117,6 @@ public void onDfuCompleted(@NonNull final String deviceAddress) {
             JSObject ret = new JSObject();
             ret.put("deviceAddress", deviceAddress);
             dfuEventListener.onDfuEvent("DFU_COMPLETED", ret);
-
             // TODO: end activity
             // new Handler()
             // .postDelayed(
@@ -144,11 +144,7 @@ public void onDfuAborted(@NonNull final String deviceAddress) {
         }
 
         @Override
-        public void onError(
-                @NonNull final String deviceAddress,
-                final int error,
-                final int errorType,
-                final String message) {
+        public void onError(@NonNull final String deviceAddress, final int error, final int errorType, final String message) {
             JSObject ret = new JSObject();
             ret.put("deviceAddress", deviceAddress);
             ret.put("error", error);
@@ -162,8 +158,7 @@ public void onResume(Context context) {
         DfuServiceListenerHelper.registerProgressListener(context, dfuProgressListener);
     }
 
-    public void onPause(Context context) {
-    }
+    public void onPause(Context context) {}
 
     public void onDestroy(Context context) {
         DfuServiceListenerHelper.unregisterProgressListener(context, dfuProgressListener);

diff --git a/example/android/capacitor.settings.gradle b/example/android/capacitor.settings.gradle
@@ -6,7 +6,7 @@ include ':capacitor-community-bluetooth-le'
 project(':capacitor-community-bluetooth-le').projectDir = new File('../node_modules/@capacitor-community/bluetooth-le/android')
 
 include ':capacitor-community-nordic-dfu'
-project(':capacitor-community-nordic-dfu').projectDir = new File('../../android')
+project(':capacitor-community-nordic-dfu').projectDir = new File('../node_modules/@capacitor-community/nordic-dfu/android')
 
 include ':capacitor-filesystem'
 project(':capacitor-filesystem').projectDir = new File('../node_modules/@capacitor/filesystem/android')

diff --git a/example/ios/App/Podfile b/example/ios/App/Podfile
@@ -12,7 +12,7 @@ def capacitor_pods
   pod 'Capacitor', :path => '../../node_modules/@capacitor/ios'
   pod 'CapacitorCordova', :path => '../../node_modules/@capacitor/ios'
   pod 'CapacitorCommunityBluetoothLe', :path => '../../node_modules/@capacitor-community/bluetooth-le'
-  pod 'CapacitorCommunityNordicDfu', :path => '../../..'
+  pod 'CapacitorCommunityNordicDfu', :path => '../../node_modules/@capacitor-community/nordic-dfu'
   pod 'CapacitorFilesystem', :path => '../../node_modules/@capacitor/filesystem'
   pod 'CapawesomeCapacitorFilePicker', :path => '../../node_modules/@capawesome/capacitor-file-picker'
 end

diff --git a/example/src/test.ts b/example/src/test.ts
@@ -2,13 +2,7 @@
 
 import 'zone.js/testing';
 import { getTestBed } from '@angular/core/testing';
-import {
-  BrowserDynamicTestingModule,
-  platformBrowserDynamicTesting,
-} from '@angular/platform-browser-dynamic/testing';
+import { BrowserDynamicTestingModule, platformBrowserDynamicTesting } from '@angular/platform-browser-dynamic/testing';
 
 // First, initialize the Angular testing environment.
-getTestBed().initTestEnvironment(
-  BrowserDynamicTestingModule,
-  platformBrowserDynamicTesting(),
-);
+getTestBed().initTestEnvironment(BrowserDynamicTestingModule, platformBrowserDynamicTesting());