Skip to content
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

GH: DocC generation and publish #4

Merged
merged 6 commits into from
Mar 14, 2024
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
15 changes: 12 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,28 @@ jobs:
- name: Zip Documentations
run: cd documentations/Build/Products/Debug; zip ../../../../documentation.zip DXFeedFramework.doccarchive -r; cd -

- name: Checkl file
- name: Create HTML Docs
run: ./build_doc.sh ${GITHUB_REPOSITORY#$GITHUB_REPOSITORY_OWNER/}
shell: sh

- name: Commit Docs
run: |
git add docs
git commit -m "Update DocC"

- name: Check file
run: ls -al release_sp.sh

- name: Calculate package checksum
run: ./release_sp.sh ${{ github.ref_name }} DXFeedFramework
shell: sh

- name: Commit files
- name: Commit spm update
run: |
git config --local user.name "GitHub Action"
git commit Package.swift -m "Update Package.swift"

- name: Push to swift branch. Update swift package.
- name: Push to swift branch. Update swift package and DocC.
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
Expand Down
1 change: 1 addition & 0 deletions DXFeedFramework/Api/DXFeed.swift
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ public extension DXFeed {
return Promise(native: nativePromise)
}

@available(iOS 13.0, *)
@available(macOS 10.15, *)
func getTimeSeries(type: IEventType.Type, symbol: Symbol, fromTime: Long, toTime: Long) -> Task<[MarketEvent]?, Error> {
let task = Task {
Expand Down
3 changes: 2 additions & 1 deletion build_doc.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
echo $1
xcodebuild docbuild -scheme DXFeedFramework -derivedDataPath documentations/

`(xcrun --find docc)` process-archive \
transform-for-static-hosting documentations/Build/Products/Debug/DXFeedFramework.doccarchive \
--output-path docs \
--hosting-base-path dxfeed-graal-swift-api
--hosting-base-path $1