-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,3 +28,4 @@ | |
# Developer | ||
|
||
- [Python](./developer/python.md) | ||
- [Release](./developer/release.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Release Management | ||
|
||
libmicrovmi project release is handled in the [CI](https://github.com/Wenzel/libmicrovmi/blob/master/.github/workflows/ci.yml), on Github Actions. | ||
|
||
If a commit is pushed with a tag matching `v*`, the `release` job of the CI is executed, | ||
as well as all jobs depending on it. | ||
|
||
Release CI related jobs | ||
|
||
- `release`: create a Github release | ||
- `release_debian`: add a Debian package to the Github release | ||
- `release_book`: build and publish the book | ||
- `publish`: publish the crate on crates.io | ||
- `publis_pypi`: publish the Python bindings on PyPI | ||
|
||
## How to make a new release | ||
|
||
Release and tags are managed using the [cargo-release](https://github.com/sunng87/cargo-release) tool. | ||
|
||
~~~ | ||
$ cargo release --no-dev-version --workspace <patch / minor / major> # will publish both libmicrovmi and the python bindings | ||
~~~ | ||
|
||
Note: `cargo-release` can handle the publication on crates.io, but we prefer to manage everything in one place, using the CI. | ||
Therefore, publishing has been explicitely disabled in `Cargo.toml` for this tool, so no mistakes can happen. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# cargo-release config file | ||
|
||
# don't create pymicrovmi-vxxx tag | ||
disable-tag = true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# cargo-release config file | ||
|
||
# internal crate, skip release process | ||
disable-release = true |