From 089435f1afab6a0b5a618cdba49af0bf91489885 Mon Sep 17 00:00:00 2001 From: Joe Heck Date: Thu, 13 Jun 2019 07:52:30 -0700 Subject: [PATCH] adding technote and readme update for CI - noting where and how CI is configured - added current build status to the README for NNW - referenced submodule builds for a complete view of the current builds in the technote --- README.md | 2 ++ Technotes/ContinuousIntegration.md | 40 ++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 Technotes/ContinuousIntegration.md diff --git a/README.md b/README.md index 58d23fecf..180476627 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # NetNewsWire +[![CircleCI](https://circleci.com/gh/brentsimmons/NetNewsWire.svg?style=svg)](https://circleci.com/gh/brentsimmons/NetNewsWire) + It’s a free and open source feed reader for macOS. It’s not in beta just yet. Getting close! While NetNewsWire 5.0 is feature-complete as of May 25, 2019, it has known bugs — and, surely, plenty of unknown bugs. diff --git a/Technotes/ContinuousIntegration.md b/Technotes/ContinuousIntegration.md new file mode 100644 index 000000000..67a0fa6c3 --- /dev/null +++ b/Technotes/ContinuousIntegration.md @@ -0,0 +1,40 @@ +# NetNewsWire Continuous Integration + +CI for NetNewsWire is enabled through CircleCI, hosted at +. The CI configuration (hosted in +[`.circleci/config.yml`](https://github.com/brentsimmons/NetNewsWire/blob/master/.circleci/config.yml) +uses `xcodebuild` to build the project after syncing the repository and +the various submodules. + +As of June 2019, CircleCI offered Xcode 10.2.1, so IOS 13 and Catalina support are not available +via CI as yet. + +The build itself focuses on the scheme NetNewsWire and leverages the +`NetNewsWire.xcworkspace` configuration. + +Each submodule also has it's own CI configuration, which are set up and built from +their own repositories. The submodule CI systems are entirely independent so that +those libraries can grow and change, getting CI verification, indepdent of NetNewsWire. + +The submodule CI are typically set to run a build and any available tests. Refer to the +project repository for the current and complete list of submodules, but for quick reference: + +- [RSCore](https://github.com/brentsimmons/RSCore) + +[![CircleCI](https://circleci.com/gh/brentsimmons/RSCore.svg?style=svg)](https://circleci.com/gh/brentsimmons/RSCore) + +- [RSCore](https://github.com/brentsimmons/RSWeb) + +[![CircleCI](https://circleci.com/gh/brentsimmons/RSWeb.svg?style=svg)](https://circleci.com/gh/brentsimmons/RSWeb) + +- [RSCore](https://github.com/brentsimmons/RSParser) + +[![CircleCI](https://circleci.com/gh/brentsimmons/RSParser.svg?style=svg)](https://circleci.com/gh/brentsimmons/RSParser) + +- [RSCore](https://github.com/brentsimmons/RSTree) + +[![CircleCI](https://circleci.com/gh/brentsimmons/RSTree.svg?style=svg)](https://circleci.com/gh/brentsimmons/RSTree) + +- [RSCore](https://github.com/brentsimmons/RSDatabase) + +[![CircleCI](https://circleci.com/gh/brentsimmons/RSDatabase.svg?style=svg)](https://circleci.com/gh/brentsimmons/RSDatabase)