Produce AsyncAPI documents at build time

thompson-tomo commented 2 months ago

Why do we need this improvement?

we should offer a dotnet tool distributed via Nuget which we call AsyncAPI.Saunter.Generation.Build as this tool enable documentation to be generated at build time.

How will this change help?

Allow for generation of documentation for worker services etc

How could it be implemented/designed?

package has a dependency on a AsyncAPI.Saunter.Generation.Core package (https://github.com/asyncapi/saunter/issues/136)
msbuild targets would call the core library & trigger the now generation which end up in the bin folder each time a build occurs the spec file.
The build task would rely on csproj properties just like nuget packaging does.

🚧 Breaking changes

No

Additional info

N/a

yurvon-screamo commented 2 months ago

Check #187

thompson-tomo commented 2 months ago

@yurvon-screamo Not sure if #187 covers it given this task explicitly talks about csproj properties as a source of information and it is automatically occurs by msbuild as part of the build process.

As such please re-open

asyncapi / saunter