improve docs #10
This file contains 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
| name: Precomp NIFs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| # Just run on main branch if "native" path changed. | |
| - "native/**" | |
| # Also run if this file changes. | |
| - ".github/workflows/release.yml" | |
| tags: | |
| # Tags will always run. | |
| - "*" | |
| pull_request: | |
| paths: | |
| # In PRs we only run if this file changes. | |
| - ".github/workflows/release.yml" | |
| workflow_dispatch: | |
| jobs: | |
| build_release: | |
| name: NIF ${{ matrix.nif }} - ${{ matrix.job.target }} (${{ matrix.job.os }}) | |
| runs-on: ${{ matrix.job.os }} | |
| permissions: | |
| contents: write | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| nif: ["2.15"] | |
| job: | |
| - { target: aarch64-unknown-linux-gnu, os: ubuntu-20.04, use-cross: true } | |
| - { target: aarch64-unknown-linux-musl, os: ubuntu-20.04, use-cross: true } | |
| - { target: aarch64-apple-darwin, os: macos-11 } | |
| - { target: x86_64-apple-darwin, os: macos-11 } | |
| - { target: x86_64-unknown-linux-gnu, os: ubuntu-20.04 } | |
| - { target: x86_64-unknown-linux-musl, os: ubuntu-20.04, use-cross: true } | |
| - { target: riscv64gc-unknown-linux-gnu, os: ubuntu-20.04, use-cross: true, cargo-args: "--no-default-features"} | |
| - { target: x86_64-pc-windows-gnu, os: windows-2022 } | |
| - { target: x86_64-pc-windows-msvc, os: windows-2019 } | |
| - { target: x86_64-unknown-freebsd, os: ubuntu-22.04, use-cross: true, cross-version: v0.2.5 } | |
| steps: | |
| - name: Checkout source code | |
| uses: actions/checkout@v3 | |
| - name: Extract crate information | |
| shell: bash | |
| run: | | |
| # Get the project version from mix.exs | |
| echo "PROJECT_VERSION=$(sed -n 's/^ @version "\(.*\)"/\1/p' mix.exs | head -n1)" >> $GITHUB_ENV | |
| - name: Add target | |
| shell: bash | |
| run: | | |
| rustup target add ${{ matrix.job.target }} | |
| - uses: Swatinem/rust-cache@v2 | |
| with: | |
| prefix-key: v0-precomp | |
| shared-key: ${{ matrix.job.target }}-${{ matrix.nif }} | |
| workspaces: | | |
| native/comrak_nif | |
| - name: Build the project | |
| id: build-crate | |
| uses: philss/rustler-precompiled-action@52c1b8dd1ed8c7fcd90ca71b177aabbd3b29b95b | |
| with: | |
| project-name: comrak_nif | |
| project-version: ${{ env.PROJECT_VERSION }} | |
| target: ${{ matrix.job.target }} | |
| nif-version: ${{ matrix.nif }} | |
| use-cross: ${{ matrix.job.use-cross }} | |
| cross-version: ${{ matrix.job.cross-version || 'v0.2.4' }} | |
| project-dir: "native/comrak_nif" | |
| cargo-args: ${{ matrix.job.cargo-args }} | |
| - name: Artifact upload | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: ${{ steps.build-crate.outputs.file-name }} | |
| path: ${{ steps.build-crate.outputs.file-path }} | |
| - name: Publish archives and packages | |
| uses: softprops/action-gh-release@v1 | |
| with: | |
| files: | | |
| ${{ steps.build-crate.outputs.file-path }} | |
| if: startsWith(github.ref, 'refs/tags/') |