Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 1.04 KB

DEVELOPMENT.md

File metadata and controls

28 lines (23 loc) · 1.04 KB

Development

Setup

  • Install the .NET Core SDK, which includes the dotnet CLI.
  • Note: Docker is required to generate the Open API code
  • Build the project with method of your choice
    • [ vscode ] run task Build Debug Mode
    • [ shell ] dotnet build ./YNAB.SDK/YNAB.SDK.csproj
  • Generate latest client based on swagger spec
    • Open shell to scripts directory
    • [ shell ] ./Generate-LatestOpenAPICodeAndDocs.ps1
  • Run tests with method of your choice
    • [ vscode ] run task Run Tests
    • [ shell ] dotnet test ./YNAB.SDK.Tests/YNAB.SDK.Tests.csproj
    • NOTE: These tests will not work for anyone else since it's currently testing against a real YNAB budget. I'll consider moving to some kind of mock in the future.

Releasing

  • Commit all changes
  • Tag master with version number
  • Open shell to scripts directory
  • [ shell ] ./Publish-NugetPackage.ps1 -NugetAPIKey my_api_key
  • Bump the version number in YNAB.SDK.csproj