Skip to content
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

Improved Wasmer C API release artifacts #1233

Merged
merged 13 commits into from
Feb 20, 2020
Merged

Improved Wasmer C API release artifacts #1233

merged 13 commits into from
Feb 20, 2020

Conversation

syrusakbary
Copy link
Member

@syrusakbary syrusakbary commented Feb 20, 2020

Description

This PR updates the artifacts generated for Wasmer C API, in a way that is much more consumable, including a quick README and License.

So, after running make capi && make build-capi We will have a wasmer-c-api.tar.gz file with the following structure

/
  lib/
    libwasmer.a
    libwasmer.so
  include/
    wasmer.h
    wasmer.hh
  README.md
  LICENSE

See example generated artifact here:
wasmer-c-api.tar.gz

Review

  • Add a short description of the the change to the CHANGELOG.md file

@@ -2,7 +2,6 @@
name = "wasmer-runtime"
version = "0.13.1"
description = "Wasmer runtime library"
documentation = "https://wasmerio.github.io/wasmer/c/runtime-c-api/"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was a wrong doc link, intended to be the runtime-c-api not for the runtime.

We are fixing it in this PR :)

@syrusakbary
Copy link
Member Author

bors try

bors bot added a commit that referenced this pull request Feb 20, 2020
@wasmerio wasmerio deleted a comment from bors bot Feb 20, 2020
bors bot added a commit that referenced this pull request Feb 20, 2020
@wasmerio wasmerio deleted a comment from bors bot Feb 20, 2020
bors bot added a commit that referenced this pull request Feb 20, 2020
@wasmerio wasmerio deleted a comment from bors bot Feb 20, 2020
@syrusakbary
Copy link
Member Author

bors try

bors bot added a commit that referenced this pull request Feb 20, 2020
Copy link
Contributor

@Hywan Hywan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Should we include the lib/runtime-c-api/doc/ directory? I think it should be great to offer offline documentation?
  2. Should we rename libwasmer_runtime_c_api to libwasmer? I understand it is simpler and shorter, but it's less self-describing. Could it “block” us for future projects or distributed/shared libraries?

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
lib/runtime-c-api/distribution/README.md Outdated Show resolved Hide resolved
@Hywan Hywan self-assigned this Feb 20, 2020
@Hywan Hywan added 🎉 enhancement New feature! 📦 lib-c-api About wasmer-c-api 🤖 bot Bip bip labels Feb 20, 2020
@bors
Copy link
Contributor

bors bot commented Feb 20, 2020

try

Build succeeded

@syrusakbary
Copy link
Member Author

syrusakbary commented Feb 20, 2020

Should we include the lib/runtime-c-api/doc/ directory? I think it should be great to offer offline documentation?

I tried, but is not trivial to do it (since it requires doxygen installed in all the distributions OR manage more artifacts between pipelines).
I think we can do it in a PR apart

Should we rename libwasmer_runtime_c_api to libwasmer? I understand it is simpler and shorter, but it's less self-describing. Could it “block” us for future projects or distributed/shared libraries?

I think we should keep it as simple as possible for now. libwasmer is a bit more aligned, since our header is named wasmer.h.

Happy to revisit this in the future though :)

Copy link
Contributor

@MarkMcCaskey MarkMcCaskey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks pretty good! My primary concern is that make build-capi doesn't seem to build the capi 🤔

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Copy link
Contributor

@MarkMcCaskey MarkMcCaskey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@syrusakbary
Copy link
Member Author

bors r+

@bors
Copy link
Contributor

bors bot commented Feb 20, 2020

Build succeeded

@bors bors bot merged commit 49ab1a1 into master Feb 20, 2020
@bors bors bot deleted the feature/release-capi branch February 20, 2020 21:05
@Hywan
Copy link
Contributor

Hywan commented Feb 21, 2020

Good job :-).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 bot Bip bip 🎉 enhancement New feature! 📦 lib-c-api About wasmer-c-api
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants