Merge pull request #7 from RusPiRo/development

Prepare Release and crates.io publishing

.cargo/config.toml

@@ -0,0 +1,5 @@
+[build]
+target = "aarch64-unknown-none"
+
+[unstable]
+build-std = ["core", "compiler_builtins", "alloc"]

.github/workflows/ci.yml

@@ -0,0 +1,179 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - development
+      - release
+  push:
+    branches:
+      - development
+      - release
+
+jobs:
+  build:
+    name: Compile The Crate
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the current code from github into the CI machine
+      - name: Checkout Code
+        uses: actions/checkout@v2
+
+      - name: Install aarch64 gcc toolchain
+        run: sudo apt-get install -y gcc-aarch64-linux-gnu
+
+      # install toolchain based on rust-toolchain file
+      - name: Install Rust Nightly and Cargo
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: nightly-2021-09-05
+          profile: minimal
+          components: rust-src, llvm-tools-preview
+          target: aarch64-unknown-none
+          override: true
+
+      - name: Install Cargo Make
+        uses: davidB/rust-cargo-make@v1
+        with:
+          version: 'latest'
+
+      - if: ${{ github.event_name != 'pull_request' }}
+        name: Remove patches if not a PR build
+        run: |
+          sed -i "/{^\[patch\.crates-io\] /{:a;N;/\Z}/!ba};/^ruspiro-.*\(git\|path\).*/d" Cargo.toml;
+          cat Cargo.toml
+
+      - name: Compile
+        run: cargo make pi3 --profile pipeline
+
+  publish_dry:
+    name: Run Cargo Publish Dry-Run
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the current code from github into the CI machine
+      - name: Checkout Code
+        uses: actions/checkout@v2
+
+      - name: Install aarch64 gcc toolchain
+        run: sudo apt-get install -y gcc-aarch64-linux-gnu
+
+      - name: Install Rust Nightly and Cargo
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: nightly-2021-09-05
+          profile: minimal
+          components: rust-src, llvm-tools-preview
+          target: aarch64-unknown-none
+          override: true
+
+      - name: Install Cargo Make
+        uses: davidB/rust-cargo-make@v1
+        with:
+          version: 'latest'
+
+      - name: Publish-Dry-Run
+        run: cargo make publish_dry --profile pipeline
+
+  prepare_release:
+    needs: [build, publish_dry]
+    if: ${{ github.ref == 'refs/heads/development' }}
+    name: Prepare Release - Create Release PR
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create PR against the release branch
+        uses: tretuna/[email protected]
+        with:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          FROM_BRANCH: "development"
+          TO_BRANCH: "release"
+          PULL_REQUEST_TITLE: "Prepare Release and crates.io publishing"
+          PULL_REQUEST_BODY: "Automatic PR to the release branch as preperation to publish the library"
+
+  deploy:
+    needs: [build, publish_dry]
+    if: ${{ github.ref == 'refs/heads/release' }}
+    name: Create Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Prepre Crate Release Version
+        run: |
+          # extract current crate version from Cargo.toml
+          echo 'CRATE_VERSION=v'$(sed -En 's/^version.*=.*\"(.*)\".*$/\1/p' < Cargo.toml) >> $GITHUB_ENV
+          # retrieve last release version from github
+          echo 'LAST_VERSION='$(curl --silent "https://api.github.com/repos/$GITHUB_REPOSITORY/releases/latest" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/') >> $GITHUB_ENV
+
+      - if: ${{ env.LAST_VERSION == '' }}
+        name: Set base version
+        run: echo 'LAST_VERSION='v0.0.0 >> $GITHUB_ENV
+
+      - name: Create Tag
+        run: |
+          echo ${{ env.CRATE_VERSION }}
+          echo ${{ env.LAST_VERSION }}
+          git config --local user.name "2ndTaleStudio"
+          git config --local user.email "[email protected]"
+          # create the TAG required for the release
+          git tag ${{ env.CRATE_VERSION }} -m "${{ env.CRATE_VERSION }}"
+          # extract the release notes of the current release from the changelog
+          sed -En '/##.*:.*:.*'"${{ env.LAST_VERSION }}"'/q;p' CHANGELOG.md > RELEASENOTES.md
+          sed -i -e 's/^# Changelog/# Release Notes/g' RELEASENOTES.md
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+        with:
+          tag_name: ${{ env.CRATE_VERSION }}
+          release_name: Release ${{ env.CRATE_VERSION }}
+          body_path: RELEASENOTES.md
+          draft: false
+          prerelease: false
+
+  publish:
+    if: ${{ github.ref == 'refs/heads/release' }}
+    needs: deploy
+    name: Run Cargo Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the current code from github into the CI machine
+      - name: Checkout Code
+        uses: actions/checkout@v2
+
+      - name: Install aarch64 gcc toolchain
+        run: sudo apt-get install -y gcc-aarch64-linux-gnu
+
+      - name: Install Rust Nightly and Cargo
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: nightly-2021-09-05
+          profile: minimal
+          components: rust-src, llvm-tools-preview
+          target: aarch64-unknown-none
+          override: true
+
+      - name: Install Cargo Make
+        uses: davidB/rust-cargo-make@v1
+        with:
+          version: 'latest'
+
+      - name: Get current version
+        run: echo 'CRATE_VERSION='$(sed -En 's/^version.*=.*\"(.*)\".*$/\1/p' < Cargo.toml) >> $GITHUB_ENV
+
+      - name: Update version place holder in files
+        run: |
+          # before actually publishing replace the final version for doc and repository in the Crago.toml
+          sed -i -e 's/||VERSION||/'$CRATE_VERSION'/g' Cargo.toml
+          # also update the version in the lib.rs doc root url
+          sed -i -e 's/||VERSION||/'$CRATE_VERSION'/g' src/lib.rs
+          # and the README.md
+          sed -i -e 's/||VERSION||/'$CRATE_VERSION'/g' README.md
+        
+      - name: Publish-Dry-Run
+        run: cargo make publish --env CRATES_TOKEN=${{ secrets.CRATES_TOKEN }} --profile pipeline

.rustfmt.toml

@@ -0,0 +1,2 @@
+# use a default of 2 spaces for indention levels
+tab_spaces = 2

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
+
+## :peach: v0.4.0
+
+- ### :wrench: Maintenance
+
+  - update travis pipeline build to support convenient publishing
+  - implement `core::fmt::Write` for both Uart types to enable them to be used with the latest `ruspiro_console::Console`
+  - upgrade the dependency for `ruspiro_register` and add `ruspiro_mmio_register` crate
+  - add MIT licencing in addition to Apache-2.0
+
 ## :banana: v0.3.1
-  - ### :detective: Fixes
-    - remove `asm!` macro usages and replace with `llvm_asm!`
-    - use `cargo make` to stabilize cross-platform builds
+
+- ### :detective: Fixes
+
+  - remove `asm!` macro usages and replace with `llvm_asm!`
+  - use `cargo make` to stabilize cross-platform builds

Cargo.toml

@@ -1,14 +1,14 @@
 [package]
 name = "ruspiro-uart"
 authors = ["André Borrmann <[email protected]>"]
-version = "0.3.1" # remember to update html_root_url
+version = "0.4.0" # remember to update html_root_url
 description = """
 Simple and convinient access API to the Raspberry Pi 3 UART0 (PL011) and UART1 (miniUART)
 peripherals
 """
-license = "Apache-2.0"
-repository = "https://github.com/RusPiRo/ruspiro-uart/tree/v0.3.1"
-documentation = "https://docs.rs/ruspiro-uart/0.3.1"
+license = "MIT | Apache-2.0"
+repository = "https://github.com/RusPiRo/ruspiro-uart/tree/v||VERSION||"
+documentation = "https://docs.rs/ruspiro-uart/||VERSION||"
 readme = "README.md"
 keywords = ["RusPiRo", "uart", "baremetal", "raspberrypi"]
 categories = ["no-std", "embedded"]
@@ -22,20 +22,19 @@ maintenance = { status = "actively-developed" }
 [lib]
 
 [dependencies]
-ruspiro-gpio = "0.4"
-ruspiro-register = "0.4"
-ruspiro-timer = "0.4"
-ruspiro-console = "0.3"
+ruspiro-gpio = "~0.4.3"
+ruspiro-register = "~0.5.4"
+ruspiro-mmio-register = "~0.1.3"
+ruspiro-timer = "~0.5.2"
 
 [features]
-default = ["ruspiro_pi3"]
 ruspiro_pi3 = [
     "ruspiro-gpio/ruspiro_pi3",
     "ruspiro-timer/ruspiro_pi3"
 ]
 
 [patch.crates-io]
-ruspiro-gpio = { git = "https://github.com/RusPiRo/ruspiro-gpio.git" }
-ruspiro-register = { git = "https://github.com/RusPiRo/ruspiro-register.git" }
-ruspiro-timer = { git = "https://github.com/RusPiRo/ruspiro-timer.git" }
-ruspiro-console = { git = "https://github.com/RusPiRo/ruspiro-console.git" }
+ruspiro-gpio = { git = "https://github.com/RusPiRo/ruspiro-gpio.git", branch = "development" }
+ruspiro-register = { git = "https://github.com/RusPiRo/ruspiro-register.git", branch = "development" }
+ruspiro-timer = { git = "https://github.com/RusPiRo/ruspiro-timer.git", branch = "development" }
+ruspiro-mmio-register = { git = "https://github.com/RusPiRo/ruspiro-mmio-register.git", branch = "development" }

LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 André Borrmann <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.