Merge pull request #47 from thenewboston-developers/develop

New release test
thenewboston-blockchain · Nov 25, 2020 · 36370f7 · 36370f7
2 parents d4cbd9a + f455e02
commit 36370f7
Show file tree

Hide file tree

Showing 2 changed files with 126 additions and 8 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -13,6 +13,19 @@ jobs:
     steps:
     - name: Checkout code
       uses: actions/checkout@v2
+      with:
+        fetch-depth: '0'
+
+    - name: Bump version and push tag
+      uses: anothrNick/github-tag-action@1.26.0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        RELEASE_BRANCHES: main
+        WITH_V: true
+
+    - name: Get Previous tag
+      id: previoustag
+      uses: "WyriHaximus/github-action-get-previous-tag@master"
 
     - name: Setup .NET Core
       uses: actions/setup-dotnet@v1
@@ -28,17 +41,17 @@ jobs:
       working-directory: ${{env.working-directory}}
 
     - name: Zip the Build
-      run: zip -r Thenewboston.${{ github.event.release.tag_name }} ${{env.working-directory}}/Thenewboston/bin/Release/netcoreapp3.1/
+      run: zip -r ${{env.working-directory}}/Thenewboston.${{ steps.previoustag.outputs.tag }}.zip ${{env.working-directory}}/Thenewboston/bin/Release/netcoreapp3.1/
 
     - name: Create 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: For release details please refer to https://github.com/thenewboston-developers/dotnetcore-sdk/releases/tag/${{ github.event.release.tag_name }}"
+        tag_name: ${{ steps.previoustag.outputs.tag }}
+        release_name: Release ${{ steps.previoustag.outputs.tag }}
+        body: Latest source code and binaries
         draft: false
         prerelease: false
 
@@ -49,13 +62,13 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
-        asset_path: ${{env.working-directory}}/Thenewboston/bin/Release/netcoreapp3.1/Thenewboston.${{ github.event.release.tag_name }}.zip
-        asset_name: ${{env.working-directory}}/Thenewboston/bin/Release/netcoreapp3.1/Thenewboston.${{ github.event.release.tag_name }}.zip
+        asset_path: ${{env.working-directory}}/Thenewboston.${{ steps.previoustag.outputs.tag }}.zip
+        asset_name: Thenewboston.${{ steps.previoustag.outputs.tag }}.zip
         asset_content_type: application/zip
 
     - name: Create NuGet Package
-      run: dotnet pack -c Release /p:Version=${{ github.event.release.tag_name }} /p:PackageReleaseNotes="Please refer to https://github.com/thenewboston-developers/dotnetcore-sdk/releases/tag/${{ github.event.release.tag_name }}"
+      run: dotnet pack -c Release /p:Version=${{ steps.previoustag.outputs.tag }} /p:PackageReleaseNotes="Please refer to https://github.com/thenewboston-developers/dotnetcore-sdk/"
       working-directory: ${{env.working-directory}}/Thenewboston
 
     - name: Publish NuGet Package
-      run: dotnet nuget push ${{env.working-directory}}/Thenewboston/bin/Release/Thenewboston.${{ github.event.release.tag_name }}.nupkg --api-key ${{ secrets.API_KEY_NUGET }} --source https://api.nuget.org/v3/index.json --no-symbols true
+      run: dotnet nuget push ${{env.working-directory}}/Thenewboston/bin/Release/Thenewboston.${{ steps.previoustag.outputs.tag }}.nupkg --api-key ${{ secrets.API_KEY_NUGET }} --source https://api.nuget.org/v3/index.json --no-symbols true
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
@@ -0,0 +1,105 @@
+
+# Thenewboston .NET Core SDK
+## Library Description
+This is a .NET Core SDK for **thenewboston**, which will be available cross-platoform. The library itself will solely contain the domain and data layers of **thenewboston**. The presentation layer will be the responsibility of the host application.
+
+
+## Getting Started
+Get started using thenewboston SDK in your project by following this documentation. The SDK is available in the following languages. 
+
+ 1. .Net Core 3.1
+ 2. Kotlin
+ 3. Python
+ 4. JavaScript
+ 5. ...
+
+## Setup Your Environment
+### Nuget
+You can use the Nuget package manager in Visual Studio or the Nuget CLI by installing the following package into a .Net Core 3.1 project:
+
+    Thenewboston
+
+For projects that support  adding  a Nuget reference you may paste the following into your .csproj file:
+
+	<ItemGroup>
+	    <PackageReference Include="Thenewboston" Version="1.0.0" />
+	</ItemGroup>
+
+## SDK References
+ 1. Bank
+	 * AccountsService
+	 * ConfigService
+	 * ConnectedBankService
+	 * TransactionService
+	 * ValidatorService
+ 2. Common
+	 * 
+ 3. Validator
+	 * AccountsService
+	 * ConfigService
+	 * ConnectedBankService
+	 * TransactionService
+	 * ValidatorService
+
+## Namespace Index
+This section provides quick links to a list of items contained within the following namespaces
+ 1. Thenewboston.Bank.Api
+ 2. Thenewboston.Bank.Models
+ 3. Thenewboston.Common.Api
+ 4. Thenewboston.Common.Models
+ 5. Thenewboston.Validator.Api
+ 6. Thenewboston.Validator.Models
+
+## Exceptions Index
+This section provides quick links to exceptions that you may encounter while using the SDK
+ 1. Bank (BNK)
+ 2. Common (CMN)
+ 3. Validator  (VLD)
+
+# Bank
+Description 
+## Namespaces
+	 Thenewboston.Bank.Api
+	 Thenewboston.Bank.Models
+	 
+## AccountsService
+##  ConfigService
+##  ConnectedBankService
+##  TransactionService
+##  ValidatorService
+##  Bank Exceptions (BNK)
+|Exception|Class|Thrown From|Description  |
+|--|--|--|--|
+|BNK001|AccountsService|SampleMethod()|Sample Description|
+|BNK002|ConfigService|SampleMethod()|Sample Description|
+|BNK003|Unassigned|Reserved for future codification|
+
+
+
+# Common
+Description
+## Namespace
+	Thenewboston.Common.Api
+	Thenewboston.Common.Models
+## Common Exceptions (CMN)
+|Exception|Class|Thrown From|Description  |
+|--|--|--|--|
+|CMN001|Unassigned |Reserved for future codification||
+
+
+# Validator
+Description
+## Namespace
+	Thenewboston.Validator.Api
+	Thenewboston.Validator.Models
+## AccountsService
+## ConfigService
+## ConnectedBankService
+## TransactionService
+## ValidatorService
+## Validator Exceptions (VLD)
+|Exception|Class|Thrown From|Description  |
+|--|--|--|--|
+|VLD001|AccountsService|SampleMethod()|Sample Description|
+|VLD002|ConfigService|SampleMethod()|Sample Description|
+|VLD003|Unassigned|Reserved for future codification|