make it easier to use local packages

.github/workflows/main.yml

@@ -111,7 +111,7 @@ jobs:
       - uses: actions/download-artifact@v3
         with:
           name: breez-sdk-flutter-${{ needs.setup.outputs.package-version }}
-          path: breez-sdk-flutter
+          path: snippets/dart_snippets/packages/breez-sdk-flutter
 
       - name: pub-get
         working-directory: snippets/dart_snippets
@@ -140,7 +140,18 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: Breez.Sdk.${{ needs.setup.outputs.package-version }}.nupkg
-          path: packages
+          path: .
+
+      - name: Create nuget package source
+        working-directory: snippets/csharp
+        run: |
+          mkdir packages
+          nuget add ../../Breez.Sdk.${{ needs.setup.outputs.package-version }}.nupkg -Source ./packages
+      
+      - name: Add nuget dependency
+        working-directory: snippets/csharp
+        run: |
+          dotnet add package Breez.Sdk -s ./packages
 
       - name: Build the csharp project
         working-directory: snippets/csharp

.gitignore

@@ -2,6 +2,4 @@ book
 .DS_Store
 .idea
 
-# Sub-projects with code snippets
+*.nupkg
-snippets/react-native/node_modules
-snippets/rust/target

snippets/csharp/README.md

@@ -0,0 +1,17 @@
+## Steps to compile the snippets locally
+1. Build a C# package
+  - By running the publish-all-platforms CI in the breez-sdk repository (use dummy binaries)
+  - or by downloading from nuget https://www.nuget.org/packages/Breez.Sdk
+2. Place it in the root folder
+
+From the `snippets/csharp` folder run the following command (replace the version):
+```bash
+nuget add ../../Breez.Sdk.1.0.0.nupkg -Source ./packages
+```
+
+Add a package reference to your local nuget package:
+```bash
+dotnet add package Breez.Sdk -s ./packages
+```
+
+Happy coding

snippets/csharp/Snippets.csproj

@@ -6,10 +6,6 @@
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
-  <PropertyGroup>
-    <RestoreSources>$(RestoreSources);../../packages;https://api.nuget.org/v3/index.json</RestoreSources>
-  </PropertyGroup>
-
   <ItemGroup>
     <PackageReference Include="Breez.Sdk" Version="*" />
   </ItemGroup>

snippets/dart_snippets/.gitignore

@@ -1,3 +1,4 @@
 # https://dart.dev/guides/libraries/private-files
 # Created by `dart pub`
 .dart_tool/
+packages/

snippets/dart_snippets/README.md

@@ -1,2 +1,6 @@
-A sample command-line application with an entrypoint in `bin/`, library code
+## Steps to compile the snippets locally
-in `lib/`, and example unit test in `test/`.
+1. Build a flutter package
+  - By running the publish-all-platforms CI in the breez-sdk repository (use dummy binaries)
+  - or by cloning https://github.com/breez/breez-sdk-flutter
+2. Place the files in the folder `snippets/dart-snippets/packages/breez-sdk-flutter`
+3. happy coding

snippets/dart_snippets/analysis_options.yaml

@@ -19,9 +19,9 @@ include: package:lints/recommended.yaml
 #   rules:
 #     - camel_case_types
 
-# analyzer:
+analyzer:
-#   exclude:
+  exclude:
-#     - path/to/excluded/files/**
+    - packages/**
 
 # For more information about the core and recommended set of lints, see
 # https://dart.dev/go/core-lints

snippets/dart_snippets/pubspec.yaml

@@ -8,7 +8,7 @@ environment:
 
 dependencies:
   breez_sdk:
-    path: ../../breez-sdk-flutter
+    path: ./packages/breez-sdk-flutter
 
 dev_dependencies:
   lints: ^2.0.0

snippets/react-native/.gitignore

@@ -0,0 +1 @@
+node_modules

snippets/rust/.gitignore

@@ -0,0 +1 @@
+target

snippets/rust/README.md

@@ -0,0 +1,3 @@
+## Steps to compile the snippets locally
+1. Update the `rev` in Cargo.toml to the commit you want to use.
+2. happy coding