Merge pull request 'Create sat-rs MIB release' (#72) from create-mib-release into main
All checks were successful
Rust/sat-rs/pipeline/head This commit looks good

Reviewed-on: #72
This commit is contained in:
Robin Müller 2023-08-28 23:40:59 +02:00
commit 2f5522b0d5
5 changed files with 44 additions and 4 deletions

View File

@ -1,7 +1,17 @@
[package] [package]
name = "satrs-mib" name = "satrs-mib"
version = "0.1.0" version = "0.1.0-alpha.0"
edition = "2021" edition = "2021"
rust-version = "1.61"
authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
description = """
Helper crate of the sat-rs framework to build a mission information base (MIB) from the
On-Board Software (OBSW) code directly."""
homepage = "https://egit.irs.uni-stuttgart.de/rust/sat-rs"
repository = "https://egit.irs.uni-stuttgart.de/rust/sat-rs"
license = "Apache-2.0"
keywords = ["no-std", "space", "aerospace"]
categories = ["aerospace", "aerospace::space-protocols", "no-std", "hardware-support", "embedded"]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@ -13,10 +23,12 @@ version = "1"
optional = true optional = true
[dependencies.satrs-core] [dependencies.satrs-core]
path = "../satrs-core" version = "0.1.0-alpha.0"
# path = "../satrs-core"
[dependencies.satrs-mib-codegen] [dependencies.satrs-mib-codegen]
path = "codegen" path = "codegen"
version = "0.1.0-alpha.0"
[dependencies.serde] [dependencies.serde]
version = "1" version = "1"

View File

@ -1,6 +1,6 @@
[package] [package]
name = "satrs-mib-codegen" name = "satrs-mib-codegen"
version = "0.1.0" version = "0.1.0-alpha.0"
edition = "2021" edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@ -16,7 +16,8 @@ quote = "1"
proc-macro2 = "1" proc-macro2 = "1"
[dependencies.satrs-core] [dependencies.satrs-core]
path = "../../satrs-core" version = "0.1.0-alpha.0"
# path = "../../satrs-core"
[dev-dependencies] [dev-dependencies]
trybuild = { version = "1", features = ["diff"] } trybuild = { version = "1", features = ["diff"] }

View File

@ -0,0 +1 @@
../LICENSE-APACHE

1
satrs-mib/codegen/NOTICE Symbolic link
View File

@ -0,0 +1 @@
../NOTICE

View File

@ -0,0 +1,25 @@
Checklist for new releases
=======
# Pre-Release
1. Make sure any new modules are documented sufficiently enough and check docs with
`cargo doc --all-features --open`.
2. Bump version specifier in `Cargo.toml`.
3. Update `CHANGELOG.md`: Convert `unreleased` section into version section with date and add new
`unreleased` section.
4. Run `cargo test --all-features`.
5. Run `cargo fmt` and `cargo clippy`. Check `cargo msrv` against MSRV in `Cargo.toml`.
6. Wait for CI/CD results for EGit and Github. These also check cross-compilation for bare-metal
targets.
# Release
1. `cargo publish`
# Post-Release
1. Create a new annotaged tag and push it with `git tag -a satrs-mib-<version>` and
`git push -u origin satrs-mib-<version>`
2. Create a new release on `EGit` based on the tag.