From cbf06a814f8aeca1972f822e25ac267de5a8beb6 Mon Sep 17 00:00:00 2001 From: Joshua Santiago <36560776+joshman1019@users.noreply.github.com> Date: Sat, 21 Nov 2020 21:29:38 -0500 Subject: [PATCH 1/9] Create DOCUMENTATION.md Created a basic documentation template for the SDK. By no means complete, but hopefully a good starting point. --- DOCUMENTATION.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 DOCUMENTATION.md diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md new file mode 100644 index 0000000..0d651f3 --- /dev/null +++ b/DOCUMENTATION.md @@ -0,0 +1,88 @@ +# 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.PackageName.Here + +For projects that support adding a Nuget reference you may paste the following into your .csproj file: + + + + + +## 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) + +# Common +Description +## Namespace + Thenewboston.Common.Api + Thenewboston.Common.Models +## Common Exceptions (CMN) + +# Validator +Description +## Namespace + Thenewboston.Validator.Api + Thenewboston.Validator.Models +## AccountsService +## ConfigService +## ConnectedBankService +## TransactionService +## ValidatorService +## Validator Exceptions (VLD) From a9411bc37ea2d1dbb0e791a4a0dd54d3bfe4dec4 Mon Sep 17 00:00:00 2001 From: Joshua Santiago <36560776+joshman1019@users.noreply.github.com> Date: Sat, 21 Nov 2020 21:34:21 -0500 Subject: [PATCH 2/9] Update DOCUMENTATION.md Slight fix due to original copy and paste error. --- DOCUMENTATION.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 0d651f3..281b5d3 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -59,7 +59,7 @@ This section provides quick links to exceptions that you may encounter while usi Description ## Namespaces Thenewboston.Bank.Api - Thenewboston.Bank.Models + Thenewboston.Bank.Models ## AccountsService ## ConfigService @@ -72,14 +72,14 @@ Description Description ## Namespace Thenewboston.Common.Api - Thenewboston.Common.Models + Thenewboston.Common.Models ## Common Exceptions (CMN) # Validator Description ## Namespace Thenewboston.Validator.Api - Thenewboston.Validator.Models + Thenewboston.Validator.Models ## AccountsService ## ConfigService ## ConnectedBankService From 4b316489151f4ab12b407ee6052a14dc13171feb Mon Sep 17 00:00:00 2001 From: Joshua Santiago <36560776+joshman1019@users.noreply.github.com> Date: Sat, 21 Nov 2020 22:53:16 -0500 Subject: [PATCH 3/9] Update DOCUMENTATION.md Update. Added sample exceptions to docs --- DOCUMENTATION.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 281b5d3..372d0d5 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -1,3 +1,4 @@ + # 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. @@ -59,7 +60,7 @@ This section provides quick links to exceptions that you may encounter while usi Description ## Namespaces Thenewboston.Bank.Api - Thenewboston.Bank.Models + Thenewboston.Bank.Models ## AccountsService ## ConfigService @@ -67,22 +68,38 @@ Description ## 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 + 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 + 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| From 69bddeb457ac2d091709ebf520b6ce61af5106ea Mon Sep 17 00:00:00 2001 From: Mircea Teodor Oprea Date: Mon, 23 Nov 2020 20:48:09 +0200 Subject: [PATCH 4/9] Update DOCUMENTATION.md --- DOCUMENTATION.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 372d0d5..cea8f59 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -17,12 +17,12 @@ Get started using thenewboston SDK in your project by following this documentati ### 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.PackageName.Here + Thenewboston For projects that support adding a Nuget reference you may paste the following into your .csproj file: - + ## SDK References From 3ecf710c2d1349166ba3426802f554d4f4d0c473 Mon Sep 17 00:00:00 2001 From: Mircea Teodor Oprea Date: Mon, 23 Nov 2020 20:48:20 +0200 Subject: [PATCH 5/9] Update DOCUMENTATION.md --- DOCUMENTATION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index cea8f59..b0674e3 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -22,7 +22,7 @@ You can use the Nuget package manager in Visual Studio or the Nuget CLI by insta For projects that support adding a Nuget reference you may paste the following into your .csproj file: - + ## SDK References From cfa412ae0160a70ea8641ac1c896bb3e6881f128 Mon Sep 17 00:00:00 2001 From: arjunraghurama Date: Wed, 25 Nov 2020 00:09:52 +0530 Subject: [PATCH 6/9] Release workflow fix. #43 Added auto tagging --- .github/workflows/release.yml | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 02db517..8beacf9 100644 --- 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.TOKEN_GITHUB }} + 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,7 +41,7 @@ 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 @@ -36,9 +49,9 @@ jobs: 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,8 +62,8 @@ 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 @@ -59,3 +72,4 @@ jobs: - 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 + \ No newline at end of file From 0ad2cbad4167ca026d104dff292c1da9c6efc3b5 Mon Sep 17 00:00:00 2001 From: arjunraghurama Date: Wed, 25 Nov 2020 00:11:40 +0530 Subject: [PATCH 7/9] Update release.yml --- .github/workflows/release.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8beacf9..f422f07 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -67,9 +67,8 @@ jobs: 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=${{ github.event.release.tag_name }} /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 - \ No newline at end of file From 343a34d52ac56688eea6b332541642cc31a84d6c Mon Sep 17 00:00:00 2001 From: arjunraghurama Date: Wed, 25 Nov 2020 00:17:15 +0530 Subject: [PATCH 8/9] Update release.yml Tag variable name change --- .github/workflows/release.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index f422f07..aa00ae8 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -67,8 +67,8 @@ jobs: 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/" + 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 From cd4e0b61ac0197ed2db6a9b349b5a1e25ba6fd69 Mon Sep 17 00:00:00 2001 From: arjunraghurama Date: Wed, 25 Nov 2020 00:20:52 +0530 Subject: [PATCH 9/9] Update release.yml --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index aa00ae8..b1e9829 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -19,7 +19,7 @@ jobs: - name: Bump version and push tag uses: anothrNick/github-tag-action@1.26.0 env: - GITHUB_TOKEN: ${{ secrets.TOKEN_GITHUB }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} RELEASE_BRANCHES: main WITH_V: true