Merge pull request #9 from probe-rs/0.8.0

Add initial CHANGELOG, bump versions & add CI

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. ...
+2. ...
+3. ...
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Stacktrace**
+If applicable, add a stacktrace to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - macOS Mojave
+ - Windows 10
+ - Linux (Ubuntu, Gentoo, Debian, Fedora, etc.)
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: Yatekii
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,16 @@
+## Thank you!
+
+Thank you for your contribution.
+Please make sure that your submission includes the following:
+
+### Must
+
+- [ ] The code compiles without `errors` or `warnings`.
+- [ ] All tests pass and in the best case you also added new tests.
+- [ ] `cargo fmt` was run.
+- [ ] Your changes were added to the `CHANGELOG.md` in the proper section.
+
+### Nice to have
+
+- [ ] You add a description of your work to this PR.
+- [ ] You added proper docs (in code, rustdoc and README.md) for your newly added features and code.

.github/workflows/ci.yml

@@ -0,0 +1,109 @@
+# Based on https://github.com/actions-rs/meta/blob/master/recipes/quickstart.md
+#
+# Currently only builds on Linux
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+name: CI
+
+jobs:
+  check:
+    name: Check
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+
+    runs-on: ${{ matrix.os }} 
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v1
+
+      - name: Install libusb
+        run: sudo apt install -y libusb-dev libusb-1.0
+        # Only install on Ubuntu
+        if: matrix.os == 'ubuntu-latest'
+
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+
+      - name: Run cargo check
+        uses: actions-rs/cargo@v1
+        with:
+          command: check
+
+  test:
+    name: Test Suite
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v1
+
+      - name: Install libusb
+        run: sudo apt install -y libusb-dev libusb-1.0
+
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+
+      - name: Run cargo test
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+
+  fmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v1
+
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+
+      - name: Install rustfmt
+        run: rustup component add rustfmt
+
+      - name: Run cargo fmt
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
+
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v1
+
+      - name: Install libusb
+        run: sudo apt install -y libusb-dev libusb-1.0
+
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+
+      - name: Install clippy
+        run: rustup component add clippy
+
+      - name: Run cargo clippy
+        uses: actions-rs/clippy-check@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --all-features 

CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Fixed
+
+## [0.3.0]
+
+### Added
+
+- Added a proper warning if no RTT channels are found to be configured.
+
+### Changed
+
+### Fixed
+
+- Fixed some error in the docs.
+
+[Unreleased]: https://github.com/probe-rs/probe-rs/compare/v0.3.0...master
+[0.3.0]: https://github.com/probe-rs/probe-rs/releases/tag/v0.3.0

probe-rs-rtt/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "probe-rs-rtt"
 description = "Host side implementation of the RTT (Real-Time Transfer) I/O protocol over probe-rs"
-version = "0.2.0"
+version = "0.3.0"
 edition = "2018"
 readme = "../README.md"
 keywords = ["embedded", "debugging", "rtt"]

probe-rs-rtt/src/rtt.rs

@@ -109,8 +109,7 @@ impl Rtt {
                 Channel::from(&session, i, memory_map, ptr + offset as u32, &mem[offset..])?
             {
                 up_channels.insert(i, UpChannel(chan));
-            }
-            else {
+            } else {
                 log::warn!("Buffer for up channel {} not initialized", i);
             }
         }
@@ -123,8 +122,7 @@ impl Rtt {
                 Channel::from(&session, i, memory_map, ptr + offset as u32, &mem[offset..])?
             {
                 down_channels.insert(i, DownChannel(chan));
-            }
-            else {
+            } else {
                 log::warn!("Buffer for down channel {} not initialized", i);
             }
         }

rtthost/Cargo.toml

@@ -8,5 +8,5 @@ authors = ["Matti Virkkunen <[email protected]>"]
 [dependencies]
 pretty_env_logger = "0.4.0"
 probe-rs = { version = "0.8.0" }
-probe-rs-rtt = { version = "0.2.0", path = "../probe-rs-rtt" }
+probe-rs-rtt = { version = "0.3.0", path = "../probe-rs-rtt" }
 structopt = "0.3.11"