Skip to content

Commit

Permalink
Add check-public-api CI workflow to track changes in the public API
Browse files Browse the repository at this point in the history
The new check-public-api workflow checks outputs a diff as an artifact
between the current master and the latest deployed version of wasmer
on crates.io

Fixes #2984
  • Loading branch information
fschutt committed Jul 5, 2022
1 parent e32ecdf commit 928827e
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
52 changes: 52 additions & 0 deletions .github/workflows/check-public-api.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Check public API

env:
RUST_BACKTRACE: 1
on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
jobs:
setup:
name: Set up
runs-on: ubuntu-latest
outputs:
VERSION: ${{ steps.setup.outputs.VERSION }}
SHOULD_CHECK_API: ${{ steps.setup.outputs.SHOULD_CHECK_API }}
steps:

- name: Set up env vars
id: setup
shell: bash
run: |
VERSION=${GITHUB_REF/refs\/tags\//}
echo ::set-output name=VERSION::${VERSION}
SHOULD_CHECK_API=$(echo $VERSION | grep -c '^[0-9]\+\.[0-9]\+\.[0-9]\+\(-\([a-zA-Z]\+\)\?[0-9]*\)\?$' || true)
echo ::set-output name=SHOULD_CHECK_API::${SHOULD_CHECK_API}
echo $VERSION
echo $SHOULD_CHECK_API
- uses: actions/checkout@v2
- name: Install latest nightly
uses: actions-rs/toolchain@v1
with:
toolchain: nightly
profile: minimal
override: true

- name: Generate API change report
run: |
cargo install cargo-public-api
cargo install ripgrep
LATEST_VERSION=$(cargo search wasmer | rg --only-matching --replace '$1' 'wasmer = "(.*)"')
cargo public-api --manifest-path=lib/api/Cargo.toml --diff-git-checkouts $LATEST_VERSION master > diff.txt
- name: Archive change report
uses: actions/upload-artifact@v3
with:
name: api-diff-report
path: |
diff.txt
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Looking for changes that affect our C API? See the [C API Changelog](lib/c-api/C
## **Unreleased**

### Changed
- [#3008](https://github.com/wasmerio/wasmer/pull/3008) Add a new CI check that uses cargo public-api to track changes in the API between master and the last deployed version on crates.io
- [#3003](https://github.com/wasmerio/wasmer/pull/3003) Remove RuntimeError::raise from public API
- [#2946](https://github.com/wasmerio/wasmer/pull/2946) Remove dylib,staticlib engines in favor of a single Universal engine
- [#2949](https://github.com/wasmerio/wasmer/pull/2949) Switch back to using custom LLVM builds on CI
Expand Down

0 comments on commit 928827e

Please sign in to comment.