Add code samples project (#254)

* add code snippets sub-project

* add samples build step to workflow

* Refactor GettingStartedSample.cs to improve snippet organization and clarity by adding snippet markers for initialization and ending, and removing redundant comments.

---------

Co-authored-by: Mateusz Wiktor <[email protected]>

Author: jakub-grzesiowski

.codacy.yml

@@ -7,4 +7,5 @@ exclude_paths:
   - '**/netstandard2.0/**'
   - '**/Plugins/**'
   - '**/Scripts/PubnubExample.*'
+  - '**/PubnubApi.Snippets/**'
 

.github/workflows/run-tests.yml

@@ -38,6 +38,8 @@ jobs:
         env:
           WORKSPACE_PATH: ${{ github.workspace }}
         run: .\\.github\\workflows\\release\\build-packages.ps1
+      - name: Build samples project
+        run: dotnet build .\\src\\PubnubApi.Snippets\\PubnubApi.Snippets.csproj
       - name: Run unit tests
         env: 
           PN_PUB_KEY: ${{ secrets.SDK_PUB_KEY }}

.gitignore

@@ -40,6 +40,15 @@ src/.vs/Pubnub/v15/sqlite3/storage.ide
 /src/Api/PubnubApi/*.user
 /src/Api/PubnubApi/Settings.StyleCop
 
+/src/PubnubApi.Snippets/bin/*
+/src/PubnubApi.Snippets/bin/Debug/*
+/src/PubnubApi.Snippets/obj/Debug/*
+/src/PubnubApi.Snippets/bin/Release/*
+/src/PubnubApi.Snippets/obj/Release/*
+/src/PubnubApi.Snippets/obj/*
+/src/PubnubApi.Snippets/*.user
+/src/PubnubApi.Snippets/Settings.StyleCop
+
 /src/Api/PubnubApiUWP/bin/*
 /src/Api/PubnubApiUWP/bin/Debug/*
 /src/Api/PubnubApiUWP/obj/Debug/*

src/Pubnub.sln

@@ -27,6 +27,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AcceptanceTests", "UnitTest
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PubnubApiUnity", "Api\PubnubApiUnity\PubnubApiUnity.csproj", "{55D8FD89-D9CF-4A11-B997-948AFF801A43}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PubnubApi.Snippets", "PubnubApi.Snippets\PubnubApi.Snippets.csproj", "{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug_Ubuntu|Any CPU = Debug_Ubuntu|Any CPU
@@ -403,6 +405,46 @@ Global
 		{55D8FD89-D9CF-4A11-B997-948AFF801A43}.Release|x64.Build.0 = Release|Any CPU
 		{55D8FD89-D9CF-4A11-B997-948AFF801A43}.Release|x86.ActiveCfg = Release|Any CPU
 		{55D8FD89-D9CF-4A11-B997-948AFF801A43}.Release|x86.Build.0 = Release|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug_Ubuntu|Any CPU.ActiveCfg = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug_Ubuntu|Any CPU.Build.0 = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug_Ubuntu|ARM.ActiveCfg = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug_Ubuntu|ARM.Build.0 = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug_Ubuntu|ARM64.ActiveCfg = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug_Ubuntu|ARM64.Build.0 = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug_Ubuntu|x64.ActiveCfg = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug_Ubuntu|x64.Build.0 = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug_Ubuntu|x86.ActiveCfg = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug_Ubuntu|x86.Build.0 = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug|ARM.ActiveCfg = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug|ARM.Build.0 = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug|ARM64.ActiveCfg = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug|ARM64.Build.0 = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug|x64.Build.0 = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Debug|x86.Build.0 = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release_Ubuntu|Any CPU.ActiveCfg = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release_Ubuntu|Any CPU.Build.0 = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release_Ubuntu|ARM.ActiveCfg = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release_Ubuntu|ARM.Build.0 = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release_Ubuntu|ARM64.ActiveCfg = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release_Ubuntu|ARM64.Build.0 = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release_Ubuntu|x64.ActiveCfg = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release_Ubuntu|x64.Build.0 = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release_Ubuntu|x86.ActiveCfg = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release_Ubuntu|x86.Build.0 = Debug|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release|Any CPU.Build.0 = Release|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release|ARM.ActiveCfg = Release|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release|ARM.Build.0 = Release|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release|ARM64.ActiveCfg = Release|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release|ARM64.Build.0 = Release|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release|x64.ActiveCfg = Release|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release|x64.Build.0 = Release|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release|x86.ActiveCfg = Release|Any CPU
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -417,6 +459,7 @@ Global
 		{C1449A27-2C29-40FF-BAD4-521BDFD323EB} = {D2051EEF-B0DA-43C4-8569-4D48FE76A5CB}
 		{15805B6C-C474-4DD7-BD7F-150A7EA23F5C} = {D2051EEF-B0DA-43C4-8569-4D48FE76A5CB}
 		{55D8FD89-D9CF-4A11-B997-948AFF801A43} = {F101EAB9-89CA-4ACB-A72B-0660F4C9CC38}
+		{87CCDCEB-CD31-4650-95FE-5BBC9CA0C0C8} = {D5BC8314-0679-4C5E-8B78-1CE761739794}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {A640EAE8-CEFD-4AFB-86DE-4112005EB515}