Skip to content

fix: use correct target name ExFigCLI for DocC build #50

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.

Sign up for GitHub

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
alexey1312 merged 1 commit into from
Feb 9, 2026
Merged

fix: use correct target name ExFigCLI for DocC build #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions .github/workflows/deploy-docc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ jobs:
- name: Build DocC
run: |
swift package --allow-writing-to-directory docs \
generate-documentation --target ExFig \
generate-documentation --target ExFigCLI \
--disable-indexing \
--transform-for-static-hosting \
--hosting-base-path ExFig \
--output-path docs
echo '<script>window.location.href += "/documentation/exfig"</script>' > docs/index.html
echo '<script>window.location.href += "/documentation/exfigcli"</script>' > docs/index.html

- uses: actions/upload-pages-artifact@v4
with:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,12 +279,12 @@ jobs:
- name: Build DocC
run: |
swift package --allow-writing-to-directory docs \
generate-documentation --target ExFig \
generate-documentation --target ExFigCLI \
--disable-indexing \
--transform-for-static-hosting \
--hosting-base-path ExFig \
--output-path docs
echo '<script>window.location.href += "/documentation/exfig"</script>' > docs/index.html
echo '<script>window.location.href += "/documentation/exfigcli"</script>' > docs/index.html

- uses: actions/upload-pages-artifact@v4
with:
Expand Down
2 changes: 1 addition & 1 deletion Sources/ExFigCLI/ExFig.docc/ExFig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ``ExFig``
# ``ExFigCLI``

CLI tool for exporting colors, typography, icons, and images from Figma to iOS, Android, and Flutter projects.

Expand Down
6 changes: 3 additions & 3 deletions mise.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,18 +135,18 @@ hk check --all 2>&1 | grep -E '^(✔|✗|hk )'
description = "Generate DocC documentation"
run = """
swift package --allow-writing-to-directory docs \
generate-documentation --target ExFig \
generate-documentation --target ExFigCLI \
--disable-indexing \
--transform-for-static-hosting \
--hosting-base-path ExFig \
Comment on lines +138 to 141

@gemini-code-assist gemini-code-assist Bot Feb 9, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The hosting-base-path on line 141 should start with a / to be treated as an absolute path from the host's root (e.g., /ExFig). This makes the generated URLs more robust and aligns with the swift-docc-plugin documentation. I've included this fix along with your change to the target.

    generate-documentation --target ExFigCLI \
    --disable-indexing \
    --transform-for-static-hosting \
    --hosting-base-path /ExFig \

--output-path docs
echo '<script>window.location.href += "/documentation/exfig"</script>' > docs/index.html
echo '<script>window.location.href += "/documentation/exfigcli"</script>' > docs/index.html
"""

[tasks."docs:preview"]
description = "Generate and preview DocC documentation"
run = """
swift package --disable-sandbox preview-documentation --target ExFig
swift package --disable-sandbox preview-documentation --target ExFigCLI
"""

[tasks.clean]
Expand Down
Loading