Skip to content

CI Improvements - GitHub workflow, make docs.rs default to macos #71

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

Merged
merged 5 commits into from
Dec 6, 2020
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
60 changes: 60 additions & 0 deletions .github/workflows/coreaudio-rs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: coreaudio-rs
on: [push, pull_request]
jobs:
# Run cargo test with default, no and all features.
macos-test:
runs-on: macOS-latest
steps:
- uses: actions/checkout@v2
- name: Install llvm and clang
run: brew install llvm
- name: Install stable
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: stable
override: true
- name: cargo test
run: cargo test --verbose
# TODO: These don't work as of 2020-12-06, but they should.
# - name: cargo test - no features
# run: cargo test --no-default-features --verbose
# - name: cargo test - all features
# run: cargo test --all-features --verbose

# Build the docs with all features to make sure docs.rs will work.
macos-docs:
runs-on: macOS-latest
steps:
- uses: actions/checkout@v2
- name: Install llvm and clang
run: brew install llvm
- name: Install stable
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: stable
override: true
- name: cargo doc - all features
run: cargo doc --all-features --verbose

# Publish a new version when pushing to master.
# Will succeed if the version has been updated, otherwise silently fails.
cargo-publish:
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
env:
CRATESIO_TOKEN: ${{ secrets.CRATESIO_TOKEN }}
runs-on: macOS-latest
steps:
- uses: actions/checkout@v2
- name: Install llvm and clang
run: brew install llvm
- name: Install stable
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: stable
override: true
- name: cargo publish
continue-on-error: true
run: cargo publish --token $CRATESIO_TOKEN
36 changes: 0 additions & 36 deletions .travis.yml

This file was deleted.

5 changes: 5 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,8 @@ core_midi = ["coreaudio-sys/core_midi"]
[dependencies]
bitflags = "1.0"
coreaudio-sys = { version = "0.2", default-features = false }

[package.metadata.docs.rs]
all-features = true
default-target = "x86_64-apple-darwin"
targets = ["x86_64-apple-darwin", "x86_64-apple-ios"]
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# coreaudio-rs [![Build Status](https://travis-ci.org/RustAudio/coreaudio-rs.svg?branch=master)](https://travis-ci.org/RustAudio/coreaudio-rs) [![Crates.io](https://img.shields.io/crates/v/coreaudio-rs.svg)](https://crates.io/crates/coreaudio-rs) [![Crates.io](https://img.shields.io/crates/l/coreaudio-rs.svg)](https://github.com/RustAudio/coreaudio-rs/blob/master/LICENSE-MIT)
# coreaudio-rs [![Actions Status](https://github.com/rustaudio/coreaudio-rs/workflows/coreaudio-rs/badge.svg)](https://github.com/rustaudio/coreaudio-rs/actions) [![Crates.io](https://img.shields.io/crates/v/coreaudio-rs.svg)](https://crates.io/crates/coreaudio-rs) [![Crates.io](https://img.shields.io/crates/l/coreaudio-rs.svg)](https://github.com/RustAudio/coreaudio-rs/blob/master/LICENSE-MIT) [![docs.rs](https://docs.rs/coreaudio-rs/badge.svg)](https://docs.rs/coreaudio-rs/)

A friendly rust interface for [Apple's Core Audio API](https://developer.apple.com/library/ios/documentation/MusicAudio/Conceptual/CoreAudioOverview/CoreAudioEssentials/CoreAudioEssentials.html).

This crate aims to expose and wrap the functionality of the original C API in a zero-cost, safe, Rust-esque manner.

If you just want direct access to the unsafe bindings, use [coreaudio-sys](https://crates.io/crates/coreaudio-sys).

[Documentation](http://rustaudio.github.io/coreaudio-rs/coreaudio)