Skip to content

Commit

Permalink
Add auto generated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
terwanerik committed Mar 31, 2022
1 parent 0f36878 commit 7cd1e1b
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 6 deletions.
53 changes: 53 additions & 0 deletions .github/workflows/document.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: AutoRelease

on:
push:
tags:
- "*"

workflow_dispatch:

jobs:
tagged-release:
runs-on: macos-latest

steps:
- uses: actions/checkout@v2

- name: Wait for build to succeed
uses: fountainhead/[email protected]
id: wait-for-build
with:
token: ${{ secrets.GITHUB_TOKEN }}
checkName: Build iOS
ref: ${{ github.event.pull_request.head.sha || github.sha }}

- name: Wait for test to succeed
if: steps.wait-for-build.outputs.conclusion == 'success'
uses: fountainhead/[email protected]
id: wait-for-test
with:
token: ${{ secrets.GITHUB_TOKEN }}
checkName: Test iOS
ref: ${{ github.event.pull_request.head.sha || github.sha }}
- name: Install Sourcekitten
run: brew install sourcekitten

- name: Install Jazzy
run: gem install jazzy

- name: Build Swift docs
run: |
sourcekitten doc --spm --module-name MMMCommonCore > swiftDoc.json
- name: Build ObjC docs
run: |
sourcekitten doc --objc $(pwd)/Sources/MMMCommonCoreObjC/include/MMMCommonCoreObjC.h \
-- -x objective-c -isysroot $(xcrun --show-sdk-path --sdk iphonesimulator) \
-I $(pwd) -fmodules > objcDoc.json
- name: Publish
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: docs
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,9 @@
/Packages
/*.xcodeproj
xcuserdata/
/.swiftpm
/.swiftpm

# Jazzy
docs/
objcDoc.json
swiftDoc.json
4 changes: 3 additions & 1 deletion MMMCommonCore.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Pod::Spec.new do |s|

s.name = "MMMCommonCore"
s.version = "1.8.3"
s.version = "1.8.4"
s.summary = "Small bits and pieces reused in many pods from MMMTemple"
s.description = s.summary
s.homepage = "https://github.com/mediamonks/#{s.name}"
Expand All @@ -21,13 +21,15 @@ Pod::Spec.new do |s|

s.subspec 'ObjC' do |ss|
ss.source_files = [ "Sources/#{s.name}ObjC/*.{h,m}" ]
ss.exclude_files = [ "Sources/#{s.name}ObjC/include/#{s.name}ObjC.h" ]
end

s.swift_versions = '5.4'
s.static_framework = true
s.pod_target_xcconfig = {
"DEFINES_MODULE" => "YES"
}

s.subspec 'Swift' do |ss|
ss.source_files = [ "Sources/#{s.name}/*.swift" ]
ss.dependency "#{s.name}/ObjC"
Expand Down
4 changes: 0 additions & 4 deletions Sources/MMMCommonCoreObjC/include/MMMCommonCoreObjC.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
// Copyright (C) 2016-2020 MediaMonks. All rights reserved.
//

#if SWIFT_PACKAGE

#import "../MMMCommonCore.h"
#import "../MMMNetworkConditioner.h"
#import "../MMMWeakProxy.h"

#endif

0 comments on commit 7cd1e1b

Please sign in to comment.