Skip to content
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.

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

iox-#75 Update links and author information #76

Merged
merged 5 commits into from
Apr 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .github/actions/build-and-cache-rust-tool/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ runs:
cat version_info
shell: bash
- name: Setup cache
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: |
~/.cargo/bin/
Expand All @@ -54,7 +54,7 @@ runs:
run: ${{ inputs.print-version-cmd }}
shell: bash
- name: Upload artifact
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: ${{ inputs.artifact-name }}
path: ${{ inputs.artifact-path }}
Expand Down
29 changes: 15 additions & 14 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Build & Test

on:
push:
branches: [ master ]
branches: [ main ]
pull_request:
branches: [ master ]
branches: [ main ]

env:
CARGO_TERM_COLOR: always
Expand All @@ -14,7 +14,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Setup Rust
uses: dtolnay/rust-toolchain@v1
with:
Expand All @@ -30,7 +30,7 @@ jobs:
os: [ubuntu-latest, macOS-latest] #Todo add windows-latest
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Build and cache cargo-nextest
uses: ./.github/actions/build-and-cache-rust-tool
with:
Expand All @@ -45,7 +45,7 @@ jobs:
needs: pre-flight-check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Build and cache grcov
uses: ./.github/actions/build-and-cache-rust-tool
with:
Expand All @@ -71,7 +71,7 @@ jobs:
continue-on-error: ${{ matrix.toolchain != 'stable' }}

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Setup Rust
uses: dtolnay/rust-toolchain@v1
with:
Expand All @@ -84,7 +84,7 @@ jobs:
cargo clippy --version >> version_info
cat version_info
- name: Setup cache
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: |
~/.cargo/bin/
Expand All @@ -94,7 +94,7 @@ jobs:
target/
key: cache-1-${{ runner.os }}-toolchain-${{ matrix.toolchain }}-${{ hashFiles('**/Cargo.toml', '**/build.rs', 'version_info') }}
- name: Download cargo-nextest artifact
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
with:
name: ${{ runner.os }}-cargo-nextest
path: ~/.cargo/bin
Expand All @@ -119,7 +119,7 @@ jobs:
needs: [cargo-nextest, grcov]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Setup Rust
uses: dtolnay/rust-toolchain@v1
with:
Expand All @@ -131,7 +131,7 @@ jobs:
cargo --version >> version_info
cat version_info
- name: Setup cache
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: |
~/.cargo/bin/
Expand All @@ -146,12 +146,12 @@ jobs:
find . -type f -wholename "**/*.profraw" -exec rm {} \;
rm -rf target/debug/coverage-html
- name: Download artifact cargo-nextest
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
with:
name: ${{ runner.os }}-cargo-nextest
path: ~/.cargo/bin
- name: Download artifact grcov
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
with:
name: ${{ runner.os }}-grcov
path: ~/.cargo/bin
Expand Down Expand Up @@ -191,7 +191,7 @@ jobs:
--output-path target/debug/coverage-html
sed -i 's/coverage/grcov/' target/debug/coverage-html/coverage.json
- name: Archive coverage-html artifacts
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: coverage-html
path: target/debug/coverage-html/*
Expand All @@ -213,7 +213,8 @@ jobs:
--ignore "**/.cargo/*" \
--output-path target/debug/lcov.info
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
uses: codecov/codecov-action@v4
with:
file: target/debug/lcov.info
fail_ci_if_error: true
token: ${{ secrets.CODECOV_TOKEN }}
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ members = [
edition = "2018"
name = "iceoryx-rs"
version = "0.1.0"
authors = ["elBoberido <k.hias@gmx.de>"]
authors = ["elBoberido <elboberido@m-hias.de>"]
description = "Safe Rust bindings for Eclipse iceoryx - true zero-copy inter-process communication"
readme = "README.md"
keywords = [
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Crates.io](https://img.shields.io/crates/v/iceoryx-rs.svg)](https://crates.io/crates/iceoryx-rs)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Build & Test](https://img.shields.io/github/actions/workflow/status/eclipse-iceoryx/iceoryx-rs/rust.yml?event=push&label=Build%20%26%20Test)](https://github.com/eclipse-iceoryx/iceoryx-rs/actions)
[![Codecov](https://codecov.io/gh/eclipse-iceoryx/iceoryx-rs/branch/master/graph/badge.svg?branch=master)](https://codecov.io/gh/eclipse-iceoryx/iceoryx-rs?branch=master)
[![Codecov](https://codecov.io/gh/eclipse-iceoryx/iceoryx-rs/branch/main/graph/badge.svg?branch=main)](https://codecov.io/gh/eclipse-iceoryx/iceoryx-rs?branch=main)

<p align="center">
<img src="https://user-images.githubusercontent.com/8661268/114321508-64a6b000-9b1b-11eb-95ef-b84c91387cff.png" width="50%">
Expand All @@ -25,7 +25,7 @@ autonomous driving with their demand on high data throughput and low latency. Wi
iceoryx also fits well into other domains where low latency and transmitting large data structures
is a concern. If you would like to know more about Eclipse iceoryx you can take a look at the
`Getting started` section on [iceoryx.io](https://iceoryx.io) or the
[README.md](https://github.com/eclipse-iceoryx/iceoryx/blob/master/README.md) of the main project.
[README.md](https://github.com/eclipse-iceoryx/iceoryx/blob/main/README.md) of the main project.

The Rust bindings are a work in progress and currently support only the pub-sub messaging pattern.
Upcoming releases will close the gap and the goal is to have the Rust bindings as a first class citizen
Expand Down Expand Up @@ -258,7 +258,7 @@ We are done. Lets run our code.
2. Start the `publisher` with `cargo run publisher`
2. Start the `subscriber` with `cargo run subscriber`

Please have a look at the [examples](https://github.com/eclipse-iceoryx/iceoryx-rs/tree/master/examples)
Please have a look at the [examples](https://github.com/eclipse-iceoryx/iceoryx-rs/tree/main/examples)
in the repository. It contains additional examples to show how uninitialized samples can be loaned and
how the `wait_for_samples` method of the `SampleReceiver` can be used to get notified on new samples.

Expand Down
2 changes: 1 addition & 1 deletion iceoryx-sys/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
edition = "2018"
name = "iceoryx-sys"
version = "0.1.0"
authors = ["elBoberido <k.hias@gmx.de>"]
authors = ["elBoberido <elboberido@m-hias.de>"]
build = "build.rs"
description = "Low level bindings for Eclipse iceoryx"
keywords = [
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
//! iceoryx also fits well into other domains where low latency and transmitting large data structures
//! is a concern. If you would like to know more about Eclipse iceoryx you can take a look at the
//! `Getting started` section on [iceoryx.io](https://iceoryx.io) or the
//! [README.md](https://github.com/eclipse-iceoryx/iceoryx/blob/master/README.md) of the main project.
//! [README.md](https://github.com/eclipse-iceoryx/iceoryx/blob/main/README.md) of the main project.
//!
//! The Rust bindings are a work in progress and currently support only the pub-sub messaging pattern.
//! Upcoming releases will close the gap and the goal is to have the Rust bindings as a first class citizen
Expand Down