search

Azure-Samples / LUIS-DevOps-Template

Template repo encapsulating best engineering practices and DevOps using GitHub Actions for the development of a LUIS application.
MIT License
21 stars 17 forks source link

Improve documentation on the why/how of the GitHub Release #33

Closed AndyCW closed 4 years ago

AndyCW commented 4 years ago

From @eedorenko : I am not sure I really understand the releasing. Why do we do that? What is the purpose of releasing the config file? I get that the release manager will compose an endpoint out of that (the endpointUrl attribute is empty, which is confusing), but why it’s not just an artifact along with test results? Does the release, in this case, represent the fact that we are promoting the model from Dev to further environments (and a release manager should take care of that)?

This needs to be documented and explained more clearly.

AndyCW commented 4 years ago

We wanted to release ‘something’ as a way of demonstrating that this build has passed quality checks and is a candidate for promoting to other dev environments, and, yes, it’s something that a Release manager would take care of. The build pipeline creates a new version+ endpoint every time it runs, but not all of them will pass the tests. If it passes the tests we needed some way of communicating that the version is ‘good’ to the users of this pipeline – hence the json file in the release (although this is let down by the fact that, as you point out, the endpoint is empty - a bug that the LUIS PG are aware of and will fix)