-
Notifications
You must be signed in to change notification settings - Fork 101
feat: add prebuilt native asset infrastructure #315
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
HamdaanAliQuatil
wants to merge
2
commits into
master
Choose a base branch
from
prebuilt-native-assets
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+240
−3
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| name: build-prebuilt-assets | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
|
|
||
| env: | ||
| PUB_ENVIRONMENT: bot.github | ||
|
|
||
| jobs: | ||
| build: | ||
| name: ${{ matrix.target }} | ||
| runs-on: ${{ matrix.os }} | ||
| timeout-minutes: 20 | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| include: | ||
| - target: linux-x64 | ||
| os: ubuntu-latest | ||
| configure_args: '' | ||
| - target: macos-arm64 | ||
| os: macos-14 | ||
| configure_args: '' | ||
| - target: macos-x64 | ||
| os: macos-13 | ||
| configure_args: '' | ||
| - target: windows-x64 | ||
| os: windows-latest | ||
| configure_args: '-A x64' | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - uses: ilammy/setup-nasm@v1 | ||
| if: runner.os == 'Windows' | ||
|
|
||
| - name: Build prebuilt asset | ||
| shell: pwsh | ||
| run: | | ||
| $install = Join-Path $env:GITHUB_WORKSPACE "prebuilt/${{ matrix.target }}" | ||
| $configureArgs = @( | ||
| '-S', 'src', | ||
| '-B', 'build/prebuilt', | ||
| '-DCMAKE_BUILD_TYPE=Release', | ||
| "-DCMAKE_INSTALL_PREFIX=$install" | ||
| ) | ||
| if ('${{ matrix.configure_args }}' -ne '') { | ||
| $configureArgs += '${{ matrix.configure_args }}'.Split(' ') | ||
| } | ||
| cmake @configureArgs | ||
| cmake --build build/prebuilt --config Release --target install | ||
|
|
||
| - name: Upload prebuilt asset | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: webcrypto-${{ matrix.target }} | ||
| path: prebuilt/${{ matrix.target }}/* | ||
| if-no-files-found: error | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # Prebuilt Native Assets | ||
|
HamdaanAliQuatil marked this conversation as resolved.
Outdated
|
||
|
|
||
| This directory is reserved for trusted prebuilt `webcrypto` native libraries. | ||
|
|
||
| The build hook looks for a target-specific dynamic library before falling back | ||
| to a local CMake source build. | ||
|
|
||
| ## Layout | ||
|
|
||
| Each target gets one directory: | ||
|
|
||
| ```text | ||
| prebuilt/ | ||
| linux-x64/ | ||
| libwebcrypto.so | ||
| macos-arm64/ | ||
| libwebcrypto.dylib | ||
| macos-x64/ | ||
| libwebcrypto.dylib | ||
| windows-x64/ | ||
| webcrypto.dll | ||
| ``` | ||
|
|
||
| iOS uses the SDK name to avoid mixing device and simulator artifacts: | ||
|
|
||
| ```text | ||
| prebuilt/ | ||
| ios-iphoneos-arm64/ | ||
| libwebcrypto.dylib | ||
| ios-iphonesimulator-arm64/ | ||
| libwebcrypto.dylib | ||
| ``` | ||
|
|
||
| Android uses the target architecture name: | ||
|
|
||
| ```text | ||
| prebuilt/ | ||
| android-arm64/ | ||
| libwebcrypto.so | ||
| android-x64/ | ||
| libwebcrypto.so | ||
| ``` | ||
|
|
||
| ## Source-Build Override | ||
|
|
||
| Consumers and CI can force a source build even when a matching prebuilt exists: | ||
|
|
||
| ```yaml | ||
| hooks: | ||
| user_defines: | ||
| webcrypto: | ||
| force_source_build: true | ||
| ``` | ||
|
|
||
| ## Policy | ||
|
|
||
| Do not accept arbitrary binary blobs from contributor PRs. Prebuilt libraries | ||
| should be generated by trusted project automation or another reviewable release | ||
| process. | ||
|
HamdaanAliQuatil marked this conversation as resolved.
Outdated
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.