Skip to content

Commit 1bff0e6

Browse files
committed
use xcodebuild docbuild instead of swift-docc-plugin
1 parent 088f048 commit 1bff0e6

File tree

2 files changed

+35
-7
lines changed

2 files changed

+35
-7
lines changed

.github/scripts/build-docc.sh

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#!/bin/bash
2+
3+
export LC_CTYPE=en_US.UTF-8
4+
5+
set -o pipefail && xcodebuild clean docbuild -scheme CodeEditTextView \
6+
-destination generic/platform=macos \
7+
OTHER_DOCC_FLAGS="--transform-for-static-hosting --hosting-base-path CodeEditTextView --output-path ./docs" | xcpretty

.github/workflows/build-documentation.yml

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,8 @@ jobs:
1111
steps:
1212
- name: Checkout repository
1313
uses: actions/checkout@v1
14-
- uses: fwcd/[email protected]
15-
with:
16-
target: CodeEditTextView
17-
output: ./docs
18-
hosting-base-path: CodeEditTextView
19-
disable-indexing: 'true'
20-
transform-for-static-hosting: 'true'
14+
- name: Build Documentation
15+
run: exec ./.github/scripts/build-docc.sh
2116
- name: Init new repo in dist folder and commit generated files
2217
run: |
2318
cd docs
@@ -34,3 +29,29 @@ jobs:
3429
branch: docs
3530
force: true
3631
directory: ./docs
32+
33+
############################
34+
##### IMPORTANT NOTICE #####
35+
############################
36+
# This was used to build the documentation catalog until
37+
# it didn't produce the 'documentation' directory anymore.
38+
#
39+
# - uses: fwcd/[email protected]
40+
# with:
41+
# target: CodeEditTextView
42+
# output: ./docs
43+
# hosting-base-path: CodeEditTextView
44+
# disable-indexing: 'true'
45+
# transform-for-static-hosting: 'true'
46+
#
47+
# The command that this plugin uses is:
48+
#
49+
# swift package --allow-writing-to-directory ./docs generate-documentation \
50+
# --target CodeEditTextView
51+
# --output-path ./docs
52+
# --hosting-base-path CodeEditTextView
53+
# --disable-indexing
54+
# --transform-for-static-hosting
55+
#
56+
# We now use xcodebuild to build the documentation catalog instead.
57+
#

0 commit comments

Comments
 (0)