ci: release assets cannot be downloaded by `install-filcrypto`
Closed this issue · 8 comments
Follow-up to #486 but slightly different.
We now have compiled bundles uploaded to the release, as per the fix in #486, e.g. https://github.com/filecoin-project/filecoin-ffi/releases/tag/v1.30.0-dev2
But previously, they were uploaded to a release that was named after the first 16 characters of the commit hash. e.g.
This is then used by the install script to download the assets:
filecoin-ffi/install-filcrypto
Lines 84 to 86 in 2a04411
I'm not actually sure of the reason behind this and I'm a little hesitant to change that behaviour (Chesterton's Fence), but I'll open a PR to at least explore changing the install script. But if we want to follow a least-change approach then we should probably be making a release with the 16 chars of the commit hash.
I think the reason for using the commit is that they were created for every commit made to master, thereby avoiding the need for everyone to compile from source if they used an untagged version:
So we need to decide if we're OK not doing that anymore.
I do not have any strong opinions if it is worth changing this behaviour, and as such it might be better just to keep to what we have today.
@magik6k / @LexLuthr as consumers of FFI, do you have any preferences on this? I.e assets are uploaded to the tag, or the assets are uploaded to a release that was named after the first 16 characters of the commit hash?
and as such it might be better just to keep to what we have today
We don't have it today unfortunately because we removed the per-commit release creation when we removed CircleCI. So if we want to do it that way then we have to do some more GHA magic to make a release per commit.
IIRC, we kept it to reduce the breakage. But I don't believe there was a strong reason to keep it that way (@cryptonemo may know more).
and as such it might be better just to keep to what we have today
We don't have it today unfortunately because we removed the per-commit release creation when we removed CircleCI. So if we want to do it that way then we have to do some more GHA magic to make a release per commit.
If we wanted to set up releases straight from master, I think we should be able to get that done in about 1 day if you wanted us to take care of it.
We could also try to revert https://github.com/filecoin-project/filecoin-ffi/pull/475/files but that would still need a couple of fixes to the publish script as it has some references to circleci that we later updated.
After verbal discussions with @BigLep, we've reached a conclusion regarding the FFI asset upload process:
We believe it's appropriate to proceed with locking in tag-only assets, given the lack of pushback on this approach. This decision is primarily driven by:
- The current absence of FFI assets causing significant inconvenience.
- The need for a timely resolution to this issue.
While we acknowledge this change may impact workflows relying on per-commit releases, such concerns haven't been voiced, and per-commit releases haven't occurred since 2024-07. The benefits of quickly concluding this matter appear to outweigh potential drawbacks.
To address FFI asset generation time concerns, we've discussed exploring more powerful custom runners for asset creation when needed.
Unless there are strong objections, I propose we move forward with the changes outlined in #492 on 2024-09-24, implementing the tag-only asset approach.