Release workflow #201

AndWeHaveAPlan · 2025-02-10T01:18:09Z

Automatically create tag and relese based on 'version' in cargo.toml, triggered on main branch only. Do nothing if tag and relese already exist
Example

Release artifacts:

llvm-linux-emscripten.tar.gz
llvm-linux-gnu.tar.gz
resolc
resolc.js
resolc.wasm

Current issues:

If build and upload fail, tag and release must be manualy deleted to trigger new build for the same tag
No tests performed for release
No Win and MacOS build

Next steps:

Workflow refactoring
Build other platforms

xermicus · 2025-02-10T12:41:53Z

Can we please test the release workflows in a fork of this repository?

xermicus · 2025-02-10T12:42:01Z

Note: The test failure is caused by a change in go-ethereum, I'm on it.

AndWeHaveAPlan · 2025-02-10T13:08:28Z

Can we please test the release workflows in a fork of this repository?

Ok, I've forked the repo to
https://github.com/paritytech/revive-worflow-test/actions/runs/13241577827

AndWeHaveAPlan · 2025-02-10T14:38:12Z

Works in fork

v0.1.0-dev.10 "release"

athei · 2025-02-10T14:59:24Z

Didn't we agree to have the LLVM release separate? Meaning it is triggered manually so that it doesn't have to be rebuild for every release.

xermicus · 2025-02-10T15:03:56Z

That was the idea at first, however not doing this simplifies the release process. It also eases changing LLVM compilation settings between releases.

AndWeHaveAPlan · 2025-02-10T15:08:40Z

Didn't we agree to have the LLVM release separate? Meaning it is triggered manually so that it doesn't have to be rebuild for every release.

This is more of a temporary solution and will change (if needed), especially with addition of the win/mac build. For now we use actions/cache with hashfiles(...) to avoid full rebuild

athei · 2025-02-10T15:09:52Z

I see. Thanks for clarifying.

xermicus · 2025-02-10T16:53:59Z

v0.1.0-dev.10 "release"

I just checked the linux binary, it isn't the statically linked MUSL build? Also the workflow does not indicate at all that it will be building against MUSL. For Linux we want the musl build (only). Easiest way is to use musl-cross, see the Dockerfile in this repository (you can essentially just build this image and then copy the bianry from a dummy container afterwards).

Note: The gnu LLVM is fine to release though. LLVM builds we want to release both: MUSL for reproducibility and GNU so that contributors with slow laptops don't have to wait for an hour.

athei · 2025-02-12T13:25:24Z

Will the rest I asked for also be removed?

AndWeHaveAPlan · 2025-02-12T14:28:02Z

Ok, lets summarize everything we have

Note: The gnu LLVM is fine to release though. LLVM builds we want to release both: MUSL for reproducibility and GNU so that contributors with slow laptops don't have to wait for an hour.

The LLVM artifacts should not be released. It is statically linked into the the other artifacts and there is no reason for people to download them. If they are released at all it will be in a separate workflow just to be downloaded by this very workflow.

So we need to release both LLVM, as mentioned here

linux-gnu (?)
macos-gnu
windows-gnu
emscripten
musl

and revive

From The final goal is to have two workflows:

build and publish LLVM as a separate tag and release (like llvm-*). Triggered manually
build and publish revive as a "true" release (like v1.2.3). Triggered for main branch by version change in cargo.toml and use llvm from the latest llvm-* release

This is a 'step 1' - 'minimal' workflow, so we can have at least some form of release for now. The LLVM release workflow is in a separate pr, but there are problems with the win build

Does everyone agree with this, or do we have a different point of view?

So I propose next steps:

Step 2: two separate releases, but only linux-musl for now
Step 3: add macos
Step 4: add windows

athei · 2025-02-12T14:34:32Z

So we need to release both LLVM, #93 (comment)

Can you scroll down a bit? Just the next post in this thread I wrote why this list of targets does not make sense. But to recap. We want those AND ONLY THOSE releases of the resolc binary:

linux-musl
macOS (universal)
windows-msvc
emscripten

So I propose next steps:

I propose you start by fixing the trivial suggestions I made here: #201 (review)

Remove all gnu builds. Not only the artifact.
Don't release any LLVM artifacts from this workflow.

I don't know how to express this in any simpler terms.

athei · 2025-02-13T17:09:04Z

Please let me know when I should give it another review. Let's merge it without mac und windows for now so we have at least that.

KarimJedda · 2025-02-14T08:16:12Z

@AndWeHaveAPlan can you please add a few more comments and address Alex's questions? Pushing changes is great, discussing & explaining them is even better! Thank you :)

AndWeHaveAPlan · 2025-02-14T08:41:21Z

fork example for current workflow

without gnu
without llvm artifacts
with new resolc_web.js file

mutantcornholio · 2025-02-14T09:56:10Z

Just to sync discussions between parallel streams: LLVM artifacts will be released in separate tags (the part I'm working on), to later be reused in this release workflow, as well as in test workflow.
#207 (comment)
#207 (comment)

athei

Thanks this looks like what we want :)

My main grumble here was that it is unclear when the author is still working on it and when it is considered "done" from their point of view. So I can start reviewing.

xermicus

Looks like we are getting close, thanks!

Can you please update the RELEASE.md file to reflect how the release works with the new workflow?

xermicus · 2025-02-14T10:30:30Z

.github/workflows/release.yml

+      - name: llvm-musl-cache save
+        if: steps.llvm-musl-cache.outputs.cache-hit != 'true'
+        uses: actions/cache/save@v4
+        with:
+          path: target-llvm/musl/target-final
+          key: llvm-linux-musl-${{ hashFiles('crates/solidity/**') }}


Should we cache the musl artifacts directly after building it? Otherwise it's either both musl and emscripten work and get cached or nothing gets cached.

ok, reordered

xermicus · 2025-02-14T10:35:27Z

.github/workflows/release.yml

+      - name: build musl
+        run: |
+          mkdir resolc-out
+          docker run -v $PWD:/opt/revive messense/rust-musl-cross:x86_64-musl /bin/bash -c "


Unfortunately it doesn't look like they version it properly with tags. Can you please change this to use the image digest? This gives us manual control and will avoid breaking the release workflow randomly.

ok, set @sha256:68b86bc7cb2867259e6b233415a665ff4469c28b57763e78c3bfea1c68091561, image used in fork workflow

xermicus · 2025-02-14T10:44:21Z

.github/workflows/release.yml

+      - name: download solc
+        run: |
+          curl -o solc https://github.com/ethereum/solidity/releases/download/v0.8.28/solc-static-linux
+          chmod +x solc
+          echo "$PWD" >> $GITHUB_PATH


This is technically not required for builds.

However, executing a basic tests using the release build, like compiling a flipper contract, would be good. Can you please add such a test? It can be really simple, i.e. running resolc --bin crates/integration/contracts/flipper.sol, expecting the PVM magic bytes 50564d in the output and expecting a return value of 0. Same for the Wasm build. It's unlikely but should the release workflow for some reason produce defective artifacts, without the test, we will only find it out the annoying way.

AndWeHaveAPlan · 2025-02-17T08:49:44Z

update:

simple resolc checks as proposed by @xermicus
fixed messense/rust-musl-cross image version
rearranged cache steps
tag and release are now created after build
updated README.md
release description extracted from README.md

fork examples (10, 11, 12)

xermicus

Looking good thanks! Just some nits then we can merge.

RELEASE.md

.github/workflows/release.yml

Co-authored-by: xermicus <[email protected]>

xermicus

Thanks! Can you please trigger it again in the fork to be sure that it works with ubuntu 24.04 runners? Once this runs through I'll merge.

AndWeHaveAPlan · 2025-02-17T09:46:09Z

Thanks! Can you please trigger it again in the fork to be sure that it works with ubuntu 24.04 runners? Once this runs through I'll merge.

just finished

xermicus · 2025-02-18T08:40:45Z

@AndWeHaveAPlan I tried the release but it failed, can you please take a look and fix it ASAP?

AndWeHaveAPlan · 2025-02-18T08:47:45Z

problem with actions permissions, fixed by repo settings for now
https://github.com/paritytech/revive/releases/tag/untagged-eddd2fa6b2a2959fe9a2

xermicus · 2025-02-18T11:38:30Z

Thanks!

llvm+resolc

3c03c72

AndWeHaveAPlan changed the title ~~llvm+resolc~~ Release workflow Feb 10, 2025

AndWeHaveAPlan added 18 commits February 10, 2025 05:21

make install-llvm

7cbda6f

make install-llvm-builder

41e7d48

solc fix

f102039

export

688570a

npm

b1c2bbf

source

bbcec97

source

c1e67ad

install gh

e46278c

token

bcd57b5

upload-release-asset@v1

4a2d343

permissions

94a25c3

artifact path

571f96c

small cleanup

0d30047

branch name

b4b5ad5

rollback version

9f3fbaa

branch

5ef47e2

version

ab5fcce

rollback

970c9f8

xermicus mentioned this pull request Feb 11, 2025

LLVM release workflows #207

Merged

remove gnu

66b6c00

Merge branch 'main' into es/release-revive

068da35

AndWeHaveAPlan requested a review from athei February 14, 2025 08:41

athei approved these changes Feb 14, 2025

View reviewed changes

xermicus requested changes Feb 14, 2025

View reviewed changes

AndWeHaveAPlan added 5 commits February 14, 2025 15:12

RUST_MUSL_CROSS_IMAGE

e6db639

release notes test

b417e2a

rollback version

102130e

resolc checks

34f4a63

release.md update

44ba9fe

AndWeHaveAPlan requested a review from xermicus February 17, 2025 08:49

xermicus reviewed Feb 17, 2025

View reviewed changes

RELEASE.md Outdated Show resolved Hide resolved

RELEASE.md Outdated Show resolved Hide resolved

.github/workflows/release.yml Show resolved Hide resolved

.github/workflows/release.yml Outdated Show resolved Hide resolved

AndWeHaveAPlan and others added 2 commits February 17, 2025 13:34

RELEASE.md suggestions

e32e58b

Co-authored-by: xermicus <[email protected]>

ubuntu-24.04

cbf9810

xermicus approved these changes Feb 17, 2025

View reviewed changes

xermicus merged commit c221044 into main Feb 17, 2025
6 checks passed

xermicus deleted the es/release-revive branch February 17, 2025 10:09

xermicus mentioned this pull request Feb 18, 2025

resolc binary releases #93

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release workflow #201

Release workflow #201

AndWeHaveAPlan commented Feb 10, 2025 •

edited

Loading

xermicus commented Feb 10, 2025

xermicus commented Feb 10, 2025

AndWeHaveAPlan commented Feb 10, 2025 •

edited

Loading

AndWeHaveAPlan commented Feb 10, 2025

athei commented Feb 10, 2025

xermicus commented Feb 10, 2025

AndWeHaveAPlan commented Feb 10, 2025

athei commented Feb 10, 2025

xermicus commented Feb 10, 2025 •

edited

Loading

athei commented Feb 12, 2025

AndWeHaveAPlan commented Feb 12, 2025

athei commented Feb 12, 2025 •

edited

Loading

athei commented Feb 13, 2025

KarimJedda commented Feb 14, 2025

AndWeHaveAPlan commented Feb 14, 2025

mutantcornholio commented Feb 14, 2025

athei left a comment

xermicus left a comment

xermicus Feb 14, 2025

AndWeHaveAPlan Feb 14, 2025

xermicus Feb 14, 2025

AndWeHaveAPlan Feb 14, 2025 •

edited

Loading

xermicus Feb 14, 2025

AndWeHaveAPlan commented Feb 17, 2025

xermicus left a comment

xermicus left a comment

AndWeHaveAPlan commented Feb 17, 2025

xermicus commented Feb 18, 2025 •

edited

Loading

AndWeHaveAPlan commented Feb 18, 2025

xermicus commented Feb 18, 2025

Release workflow #201

Release workflow #201

Conversation

AndWeHaveAPlan commented Feb 10, 2025 • edited Loading

xermicus commented Feb 10, 2025

xermicus commented Feb 10, 2025

AndWeHaveAPlan commented Feb 10, 2025 • edited Loading

AndWeHaveAPlan commented Feb 10, 2025

athei commented Feb 10, 2025

xermicus commented Feb 10, 2025

AndWeHaveAPlan commented Feb 10, 2025

athei commented Feb 10, 2025

xermicus commented Feb 10, 2025 • edited Loading

athei commented Feb 12, 2025

AndWeHaveAPlan commented Feb 12, 2025

athei commented Feb 12, 2025 • edited Loading

athei commented Feb 13, 2025

KarimJedda commented Feb 14, 2025

AndWeHaveAPlan commented Feb 14, 2025

mutantcornholio commented Feb 14, 2025

athei left a comment

Choose a reason for hiding this comment

xermicus left a comment

Choose a reason for hiding this comment

xermicus Feb 14, 2025

Choose a reason for hiding this comment

AndWeHaveAPlan Feb 14, 2025

Choose a reason for hiding this comment

xermicus Feb 14, 2025

Choose a reason for hiding this comment

AndWeHaveAPlan Feb 14, 2025 • edited Loading

Choose a reason for hiding this comment

xermicus Feb 14, 2025

Choose a reason for hiding this comment

AndWeHaveAPlan commented Feb 17, 2025

xermicus left a comment

Choose a reason for hiding this comment

xermicus left a comment

Choose a reason for hiding this comment

AndWeHaveAPlan commented Feb 17, 2025

xermicus commented Feb 18, 2025 • edited Loading

AndWeHaveAPlan commented Feb 18, 2025

xermicus commented Feb 18, 2025

AndWeHaveAPlan commented Feb 10, 2025 •

edited

Loading

AndWeHaveAPlan commented Feb 10, 2025 •

edited

Loading

xermicus commented Feb 10, 2025 •

edited

Loading

athei commented Feb 12, 2025 •

edited

Loading

AndWeHaveAPlan Feb 14, 2025 •

edited

Loading

xermicus commented Feb 18, 2025 •

edited

Loading