ci: automatically publish github releases

[Vaiz]

Adds a workflow that automatically creates releases when a new tag is pushed
example of a release: https://github.com/microsoft/oxidizer/releases/tag/uniflight-v0.1.0

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.0%. Comparing base (8e1d5d2) to head (f9288c3).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #247   +/-   ##
=======================================
  Coverage   100.0%   100.0%           
=======================================
  Files         139      139           
  Lines        8420     8420           
=======================================
  Hits         8420     8420           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sandersaares]

The title is about creating release notes:

ci: automatically publish release notes #247

Yet the description is about publishing releases. What exactly is this PR meant to be about? Let's align title & description, please.

There are a workflows and script added but I see no instructions on how to use them. Feels like something is missing. It should be clear to contributors how to use the workflows and scripts we have - do we need to additionally document these in README.md or some similar place?

[Vaiz]

Yet the description is about publishing releases. What exactly is this PR meant to be about?

there is some mix up in terms, this PR enables automatic creation of github releases, which are different from publishing crates to crates.io

I've manually created github releases for latest versions of the crates, but doing it manually every time a crate is published is not feasible

There are a workflows and script added but I see no instructions on how to use them. Feels like something is missing. It should be clear to contributors how to use the workflows and scripts we have - do we need to additionally document these in README.md or some similar place?

I can add comments into pipeline file/script, but pushing everything into common README.md seems an overkill to me

[sandersaares]

I can add comments into pipeline file/script, but pushing everything into common README.md seems an overkill to me

If a user is expected to do something, it should be documented. Or are you saying these workflow + script are hands-off, never need to be executed by user? In that case a comment in the workflow/script on when/how they are executed should be sufficient, I agree.

[geeknoid]

So what's the motivation for creating GitHub releases? I don't see the value for Rust crates, since crates.io is all that someone needs. Isn't this just pure overhead?

If we were publishing binaries, then I think it would be useful to create releases.

[Vaiz]

So what's the motivation for creating GitHub releases? I don't see the value for Rust crates, since crates.io is all that someone needs. Isn't this just pure overhead?

If we were publishing binaries, then I think it would be useful to create releases.

the main motivation is to publish changelog somewhere where people can actually see it
it's a first place where I go to check what has changed

[Vaiz]

If a user is expected to do something, it should be documented. Or are you saying these workflow + script are hands-off, never need to be executed by user? In that case a comment in the workflow/script on when/how they are executed should be sufficient, I agree.

they should be executed automatically after ADO pipeline pushes a release tag to github repo, at least this is how it's supposed to work

[sandersaares]

If we are discussing the value of changelogs and how we deal with them, maybe this is a conversation we should have separate from the PR. Because IMO the value is negative and I feel cheated by having reviewed a PR that deals with publishing a resource drain!

[sandersaares]

they should be executed automatically after ADO pipeline pushes a release tag to github repo, at least this is how it's supposed to work

Please document this in the relevant workflow/script/somewhere so the context of these workflows/scripts is understandable without reverse engineering.