johnazariah / tugboat Goto Github PK

[x] Register Packages for Tugboat Library and Tugboat Templates
[x] Get Nuget API key for Github CI pipline
[x] Configure Github Repository to be able to push to Nuget
[x] Configure Github Actions to publish library and template packages on appropriate tags
[x] Ensure a generation from Nuget templates results in valid code

As an application developer
I want to use a Tugboat template
So I can have a working reference WebAPI application

• Create a basic WebAPI application with support for
  • Swagger
  • AppInsights
• Templatize the application
• Package within Tugboat

As an application developer
I want a docker image set up with all necessary tools
So I can develop and deploy tugboat applications without having to install anything on my development machine*

• Minimize requirements on development machine to:

  • docker (with kubernetes)
  • visual studio code

• Develop a docker image with all tools required

  • make
  • git
  • dotnet sdk
  • gh (the github cli)
  • az (the az cli tool)
  • kubectl

• Create a repository on docker hub for the tugboat development environment image

• Test that running the docker image is sufficient to allow complete development

• Create a github action to build and push the image automatically when the Dockerfile is updated

• Setup Github Repository
• Add License & README
• Migrate Library Code from Orleans UniversalSilo
• Make name changes -> tugboat as appropriate
• Remove superfluous templates
• Create webapi template appropriate for .NET projects in C# and F#
• Fix github actions to do a complete build-generate-verify cycle for each template/language pair

If you're following the Tugboat setup, be sure to use short names for the org and project variables in Defaults.Makefile. If they total over 21 characters then with stg appended to the front it will exceed the maximum length 24 for a storage account name.

• Setup docs directory. Support documentation in GFM.
• Setup generation of gh-pages
• Decide on top level TOI
  • Setting up development environment
  • Building and testing .NET application with dotnet
  • Building and testing application with docker
  • Deploying and running application in Kubernetes locally
  • Setting up Azure Infrastructure (organization)
  • Setting up Azure Infrastructure (project)
  • Deploying and running application in Azure with Tugboat
  • Describe reference architecture and network topology
  • Describe development workflows (branch build, main build, push to staging, push to prod)
  • Describe deployment workflows (blue-green)
  • Describe extension mechanisms (multiple region etc)

Question: Should we use Github Packages as a supplement for Nuget and Docker Hub?
Question: Should we use Github Packages as a replacement for Nuget and Docker Hub?