Generate and push HTML documentation #236
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: sam <[email protected]>
Co-authored-by: sam <[email protected]>
Comment on lines
+17
to
+116
| runs-on: macos-latest | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Swift | ||
| uses: swift-actions/setup-swift@v1 | ||
| with: | ||
| swift-version: '5.9' | ||
|
|
||
| - name: Cache Swift packages | ||
| uses: actions/cache@v3 | ||
| with: | ||
| path: .build | ||
| key: ${{ runner.os }}-swift-${{ hashFiles('**/Package.resolved') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-swift- | ||
|
|
||
| - name: Build package | ||
| run: swift build | ||
|
|
||
| - name: Generate documentation | ||
| run: | | ||
| # Generate documentation for the Clerk target | ||
| swift package generate-documentation \ | ||
| --target Clerk \ | ||
| --disable-indexing \ | ||
| --transform-for-static-hosting \ | ||
| --hosting-base-path Clerk \ | ||
| --output-path ./docs | ||
|
|
||
| - name: Setup docs directory structure | ||
| run: | | ||
| # Create a clean docs directory structure | ||
| mkdir -p ./docs-output | ||
|
|
||
| # Copy the generated documentation | ||
| if [ -d "./docs" ]; then | ||
| cp -r ./docs/* ./docs-output/ | ||
| fi | ||
|
|
||
| # Create index.html if it doesn't exist | ||
| if [ ! -f "./docs-output/index.html" ]; then | ||
| cat > ./docs-output/index.html << 'EOF' | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <title>Clerk Documentation</title> | ||
| <meta charset="UTF-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <style> | ||
| body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; margin: 40px; } | ||
| .header { text-align: center; margin-bottom: 40px; } | ||
| .links { display: flex; justify-content: center; gap: 20px; flex-wrap: wrap; } | ||
| .link { padding: 10px 20px; background: #007AFF; color: white; text-decoration: none; border-radius: 8px; } | ||
| .link:hover { background: #0056CC; } | ||
| </style> | ||
| </head> | ||
| <body> | ||
| <div class="header"> | ||
| <h1>Clerk Documentation</h1> | ||
| <p>Swift Package Documentation</p> | ||
| </div> | ||
| <div class="links"> | ||
| <a href="./documentation/clerk/" class="link">Browse Documentation</a> | ||
| </div> | ||
| </body> | ||
| </html> | ||
| EOF | ||
| fi | ||
|
|
||
| - name: Deploy to docs branch | ||
| run: | | ||
| # Configure git | ||
| git config --global user.name 'github-actions[bot]' | ||
| git config --global user.email 'github-actions[bot]@users.noreply.github.com' | ||
|
|
||
| # Create/checkout docs branch | ||
| git checkout --orphan docs || git checkout docs | ||
|
|
||
| # Remove all files except docs-output | ||
| git rm -rf . 2>/dev/null || true | ||
|
|
||
| # Copy documentation files to root | ||
| cp -r ./docs-output/* . 2>/dev/null || true | ||
|
|
||
| # Add and commit all documentation files | ||
| git add . | ||
|
|
||
| # Check if there are changes to commit | ||
| if git diff --staged --quiet; then | ||
| echo "No changes to commit" | ||
| exit 0 | ||
| fi | ||
|
|
||
| git commit -m "📚 Update documentation ($(date '+%Y-%m-%d %H:%M:%S'))" | ||
|
|
||
| # Push to docs branch | ||
| git push origin docs --force |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix
AI 4 months ago
To fix the issue, we will add a permissions block at the root of the workflow file. This block will explicitly define the minimal permissions required for the workflow to function. Based on the workflow's actions, it needs contents: write to push changes to the docs branch and contents: read to access the repository's files. These permissions will be applied to all jobs in the workflow.
Suggested changeset
1
.github/workflows/docs.yml
| @@ -2,2 +2,5 @@ | ||
|
|
||
| permissions: | ||
| contents: write | ||
|
|
||
| on: |
Copilot is powered by AI and may make mistakes. Always verify output.
malafama122
approved these changes
Oct 2, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a GitHub Action to automatically generate Swift-DocC HTML documentation and push it to a dedicated
docsbranch.Slack Thread