Skip to content

Publishing a documentation catalog on GitHub pages #168

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
marinofaggiana merged 2 commits into from
Jul 21, 2025
Merged

Publishing a documentation catalog on GitHub pages #168

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d502540
feat(doc): Building and publishing a documentation catalog on GitHub …
i2h3 Jul 18, 2025
2012aa4
Merge branch 'main' into documentation-catalog
marinofaggiana Jul 21, 2025
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
70 changes: 70 additions & 0 deletions .github/workflows/documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# SPDX-FileCopyrightText: Nextcloud GmbH
# SPDX-FileCopyrightText: 2025 Iva Horn
# SPDX-License-Identifier: GPL-3.0-or-later

name: Documentation

on:
push:
branches:
- main

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
build-docs:
runs-on: macos-latest
steps:
- uses: maxim-lobanov/setup-xcode@v1
with:
xcode-version: latest-stable
- uses: actions/checkout@v4
- name: Build documentation
run: |
xcodebuild docbuild \
-scheme NextcloudKit \
-destination 'platform=macOS' \
-skipPackagePluginValidation \
-derivedDataPath ./DerivedData
$(xcrun --find docc) process-archive \
transform-for-static-hosting ./DerivedData/Build/Products/Debug/NextcloudKit.doccarchive \
--output-path ./docs \
--hosting-base-path /nextcloudkit
- name: Create root redirect
run: |
cat > ./docs/index.html << 'EOF'
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>NextcloudKit Documentation</title>
<meta http-equiv="refresh" content="0; url=./documentation/nextcloudkit/">
<link rel="canonical" href="./documentation/nextcloudkit/">
</head>
<body>
<p>Redirecting to <a href="./documentation/nextcloudkit/">NextcloudKit Documentation</a>...</p>
<script>
window.location.href = "./documentation/nextcloudkit/";
</script>
</body>
</html>
EOF
- name: Upload static files as artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs
deploy-docs: # See: https://github.com/actions/deploy-pages
needs: build-docs
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
Loading