rust-embedded / svd2rust

Generate Rust register maps (`struct`s) from SVD files
Apache License 2.0
687 stars 149 forks source link

ci: add date and changelog to pre-release #608

Closed duskmoon314 closed 2 years ago

duskmoon314 commented 2 years ago
rust-highfive commented 2 years ago

r? @burrbull

(rust-highfive has picked a reviewer for you, use r? to override)

duskmoon314 commented 2 years ago

TODO:

burrbull commented 2 years ago

No need in unzipped versions

duskmoon314 commented 2 years ago

Now I use the solution kind of a copy from cross. The body is extracted from CHANGELOG and marked as pre-release if it is Unreleased. But there isn't a link to the comparison page.

Any suggestion on improving this? @Emilgardis

An example is like below

image
Emilgardis commented 2 years ago

In changelog.md, add the tag..head link as the previous version would do but instead add it directly to the file. When we do a release, we'll have to make sure that a new link is added.

~One note from me, is the above even needed, the releases page has a Changes link which serves the same purpose~ yes its needed, that way one would get the information when reading the changelog file directly

r? burbull

@burrbull you've done the most releases, what do you think about this 😁

burrbull commented 2 years ago

@burrbull you've done the most releases, what do you think about this grin

LGTM. I'm planning to release after this is merged.

@duskmoon314 is this still draft?

duskmoon314 commented 2 years ago

I think if it's ok to not have the link for now, this is not a draft. Currently, I use changelog-reader-action and the link is lost.


TLDR: We need to delete the previous release made by the action which is tagged as pre-release

Besides, the action to make the release doesn't support deleting the previous one. So it just updates the one with the same tag. We need to delete the release made by the previous action to remove uncompressed binaries.

Notes: now the action tags the unreleased version with Unreleased. So we need to delete the previous one to not confuse people. 😂

Emilgardis commented 2 years ago

Notes: now the action tags the unreleased version with Unreleased. So we need to delete the previous one to not confuse people. 😂

I don't understand, how would this cause confusion?

We need to delete the release made by the previous action to remove uncompressed binaries.

why does it not touch the uncompressed binaries?

burrbull commented 2 years ago

bors r+

duskmoon314 commented 2 years ago

how would this cause confusion?

In my point of view, finding two pre-release status releases on the release page is somewhat confusing. Though one is outdated once this is merged.

why does it not touch the uncompressed binaries?

It seems the action will only update the release if it finds the release existed. Then it updates artifacts with the same name and keeps others. That is, the previous action updated an artifact called a, and the new action uploads a.gz and keeps a still in the release.

My opinion is to delete the previous one which is tagged pre-release and let the action create a new one tagged Unreleased. This will solve the two problems above.

Emilgardis commented 2 years ago

ah right, you mean in the first run of this only, in future runs it won't matter.

Was thinking you meant it will always do this

duskmoon314 commented 2 years ago

Sorry for not being clear. Yes, I indeed mean the first run.

burrbull commented 2 years ago

@duskmoon314 What do you think about similar work for other tools like svdtools, cargo-binutils?

duskmoon314 commented 2 years ago

@burrbull You mean adding action like this to other projects? I am definitely willing to help.

bors[bot] commented 2 years ago

Build succeeded: