Skip to content

Improved documentation for rust crate release process - #423

Open
joeslice wants to merge 4 commits into
kson-org:mainfrom
joeslice:rust-release
Open

Improved documentation for rust crate release process#423
joeslice wants to merge 4 commits into
kson-org:mainfrom
joeslice:rust-release

Conversation

@joeslice

@joeslice joeslice commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Included are the improvements to the release documentation for the rust library as tested in the 0.3.0 release. Additionally, a bonus change to improve the rust readme.

Included is an untested draft version of release steps that might be useful when shipping a new release of the rust artifacts to crates.io. This should be validated and corrected with Adolfo's help before carrying on.
@joeslice
joeslice requested a review from aochagavia August 26, 2026 13:07
Comment thread docs/release_process.md Outdated

- `jni_simplified.h` — bindgen generates the bindings from this header; the build fails
without it
- `graal_isolate.h` and `graal_isolate_dynamic.h`

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I'm not 100% sure these are needed, but there's no harm in shipping them

@aochagavia aochagavia left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM 😉

Simplifying and improving the instructions while testing them.
This step was missed 17d124d and 3c147dd.

`cargo publish` was the first to regenerate and notice an error here.
@joeslice joeslice changed the title WIP: Draft rust crate release process Improved documented rust crate release process Aug 26, 2026
@joeslice joeslice changed the title Improved documented rust crate release process Improved documentation for rust crate release process Aug 26, 2026
The prior example was no longer accurate since requiring `options` instead of a boolean. This new example demonstrates some indentation options and also a bit more about the json->kson pipeline.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants