Skip to content

Update release docs #1153

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.

Sign up for GitHub

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

Merged
saulecabrera merged 1 commit into from
Mar 17, 2026
Merged

Update release docs #1153

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 13 additions & 15 deletions docs/docs-contributing-releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
# CLI releases

1. Update the root `Cargo.toml` with the new version, following semver.
2. Create a tag for the new version like `v0.2.0`.
# Crate releases

```
git tag v0.2.0
git push origin --tags
```

3. Create a new release from the new tag in github
[here](https://github.com/bytecodealliance/javy/releases/new).
4. A GitHub Action will trigger for `publish.yml` when a release is published
([i.e. it doesn't run on
drafts](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#:~:text=created%2C%20edited%2C%20or%20deleted%20activity%20types%20for%20draft%20releases)),
creating the artifacts for downloading.
1. Merge a PR removing the `-alpha` suffix on the crate versions.
2. Change directories into the crate version you want to publish and run
`./publish.sh`. If you're publishing `javy` and `javy-plugin-api`, publish
the `javy` crate first.

# CLI releases

1. Merge a PR updating the root `Cargo.toml` with the new version, following
semver.
2. Create a new release in GitHub
[here](https://github.com/bytecodealliance/javy/releases/new). On the page
creating the release, create a new tag and title that are set to `v`
followed by the new version in the root `Cargo.toml`, for example `v8.0.0`.
The `build-assets` workflow should attach artifacts to the new release.
Loading