Skip to content

Commit

Permalink
remove circleci, enable github actions
Browse files Browse the repository at this point in the history
Signed-off-by: Connor Rigby <connorr@hey.com>
  • Loading branch information
ConnorRigby committed Sep 21, 2023
1 parent be60bfc commit 4acd8c1
Show file tree
Hide file tree
Showing 3 changed files with 89 additions and 67 deletions.
62 changes: 0 additions & 62 deletions .circleci/config.yml

This file was deleted.

87 changes: 87 additions & 0 deletions .github/workflows/elixir.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
name: mix test

# Define workflow that runs when changes are pushed to the
# `main` branch or pushed to a PR branch that targets the `main`
# branch. Change the branch name if your project uses a
# different name for the main branch like "master" or "production".
on:
push:
branches: [ "main" ] # adapt branch for project
pull_request:
branches: [ "main" ] # adapt branch for project

# Sets the ENV `MIX_ENV` to `test` for running tests
env:
MIX_ENV: test

permissions:
contents: read

jobs:
test:
runs-on: ubuntu-latest
name: Test on OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}}
strategy:
# Specify the OTP and Elixir versions to use when building
# and running the workflow steps.
matrix:
otp: ['25.0.4'] # Define the OTP version [required]
elixir: ['1.14.1'] # Define the elixir version [required]
steps:
# Step: Setup Elixir + Erlang image as the base.
- name: Set up Elixir
uses: erlef/setup-beam@v1
with:
otp-version: ${{matrix.otp}}
elixir-version: ${{matrix.elixir}}

# Step: Check out the code.
- name: Checkout code
uses: actions/checkout@v3

# Step: Define how to cache deps. Restores existing cache if present.
- name: Cache deps
id: cache-deps
uses: actions/cache@v3
env:
cache-name: cache-elixir-deps
with:
path: deps
key: ${{ runner.os }}-mix-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
restore-keys: |
${{ runner.os }}-mix-${{ env.cache-name }}-
# Step: Define how to cache the `_build` directory. After the first run,
# this speeds up tests runs a lot. This includes not re-compiling our
# project's downloaded deps every run.
- name: Cache compiled build
id: cache-build
uses: actions/cache@v3
env:
cache-name: cache-compiled-build
with:
path: _build
key: ${{ runner.os }}-mix-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
restore-keys: |
${{ runner.os }}-mix-${{ env.cache-name }}-
${{ runner.os }}-mix-
# Step: Download project dependencies. If unchanged, uses
# the cached version.
- name: Install dependencies
run: mix deps.get

# Step: Compile the project treating any warnings as errors.
# Customize this step if a different behavior is desired.
- name: Compiles without warnings
run: mix compile --warnings-as-errors

# Step: Check that the checked in code has already been formatted.
# This step fails if something was found unformatted.
# Customize this step as desired.
- name: Check Formatting
run: mix format --check-formatted

# Step: Execute the tests.
- name: Run tests
run: mix test
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,9 @@

[![Hex version](https://img.shields.io/hexpm/v/blue_heron_transport_uart.svg "Hex version")](https://hex.pm/packages/blue_heron_transport_uart)
[![API docs](https://img.shields.io/hexpm/v/blue_heron_transport_uart.svg?label=hexdocs "API docs")](https://hexdocs.pm/blue_heron_transport_uart/BlueHeronTransportUART.html)
[![CircleCI](https://circleci.com/gh/blue-heron/blue_heron_transport_uart/tree/main.svg?style=svg)](https://circleci.com/gh/blue-heron/blue_heron_transport_uart/tree/main)
[![mix test](https://github.com/blue-heron/blue_heron_transport_uart/actions/workflows/elixir.yaml/badge.svg)](https://github.com/blue-heron/blue_heron_transport_uart/actions/workflows/elixir.yaml)

BlueHeron supports UART-based Bluetooth modules. Currently, this ONLY includes
the Cypress Semiconductor
[BCM43438](https://www.cypress.com/part/cychpset-p62s143438-1). This part is on
the Raspberry Pi Zero W and the Raspberry Pi 3 B. It is NOT on the 3 B+.
BlueHeron supports UART-based Bluetooth modules.

To use, add `:blue_heron_transport_uart` to your `mix.exs` dependencies and
adapt the following to initialize a transport context.
Expand Down

0 comments on commit 4acd8c1

Please sign in to comment.