Skip to content

Commit

Permalink
Deprecate bindings crates (#641)
Browse files Browse the repository at this point in the history
This commit is a follow-up to #618, to formally mark `quckjs-wasm-{sys, rs}` crates as deprecated.

The rollout strategy is to:

* Merge this PR
* Publish the a new version of each of the crates, containing the last unreleased change in each and the deprecation notice.
  • Loading branch information
saulecabrera authored May 7, 2024
1 parent 8877be4 commit 0a73a51
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 0 deletions.
1 change: 1 addition & 0 deletions crates/quickjs-wasm-rs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

- Mark crate as deprecated
- Add a new `expose-sys` feature that exposes unstable escape hatch functions to the underlying `quickjs_wasm_sys` crate.

## [3.0.0] - 2024-01-31
Expand Down
3 changes: 3 additions & 0 deletions crates/quickjs-wasm-rs/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@ serde_bytes = "0.11.14"
[features]
# Re-exports the quickjs-wasm-sys module and exposes additional, unstable APIs.
export-sys = []

[badges]
maintenance = { status = "deprecated" }
9 changes: 9 additions & 0 deletions crates/quickjs-wasm-rs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
# This crate is deprecated.
[![crates.io](https://img.shields.io/crates/v/quickjs-wasm-rs.svg)](https://crates.io/crates/quickjs-wasm-rs)

The motivation for this change is explained in detail in
https://github.com/bytecodealliance/javy/pull/618

We recommend using [`rquickjs`](https://github.com/DelSkayn/rquickjs) as the
high-level bindings for QuickJS.

# quickjs-wasm-rs

High-level bindings and serializers for a Wasm build of QuickJS.
Expand Down
1 change: 1 addition & 0 deletions crates/quickjs-wasm-sys/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased changes

- Mark crate as deprecated.
- Expose `JS_DupValue` via `JS_DupValueExt`.

## [1.2.0] - 2024-01-31
Expand Down
3 changes: 3 additions & 0 deletions crates/quickjs-wasm-sys/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,6 @@ http-body-util = "0.1.1"
hyper = "1.3"
hyper-tls = "0.6.0"
hyper-util = { version = "0.1.3", features = ["http1"] }

[badges]
maintenance = { status = "deprecated" }
11 changes: 11 additions & 0 deletions crates/quickjs-wasm-sys/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# This crate is deprecated.
[![crates.io](https://img.shields.io/crates/v/quickjs-wasm-sys.svg)](https://crates.io/crates/quickjs-wasm-sys)

The motivation for this change is explained in detail in
https://github.com/bytecodealliance/javy/pull/618

We recommend using [`rquickjs`](https://github.com/DelSkayn/rquickjs) as the
high-level bindings for QuickJS.

# quickjs-wasm-sys: Wasm QuickJS bindings for Rust

High-level bindings and serializers for a Wasm build of QuickJS.

FFI bindings for a Wasm build of the QuickJS Javascript engine.

## Publishing to crates.io
Expand Down

0 comments on commit 0a73a51

Please sign in to comment.