https://github.com/g1j0shi/swift-doc-deployment
Deploys the Swift documentation to GitHub pages.
https://github.com/g1j0shi/swift-doc-deployment
deployment githib-pages github-actions publishing swift
Last synced: 30 days ago
JSON representation
Deploys the Swift documentation to GitHub pages.
- Host: GitHub
- URL: https://github.com/g1j0shi/swift-doc-deployment
- Owner: G1J0SHI
- Created: 2025-01-04T15:08:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-12T13:58:13.000Z (5 months ago)
- Last Synced: 2026-01-12T20:15:23.926Z (5 months ago)
- Topics: deployment, githib-pages, github-actions, publishing, swift
- Homepage: https://github.com/marketplace/actions/swift-doc-deployment
- Size: 8.79 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub Action
## Swift Doc Deployment
### Deploys the Swift documentation to GitHub pages.
#### Setup
Before using this action, enable GitHub Pages in your repository:
1. Go to your repository **Settings**
2. Navigate to **Pages** in the left sidebar
3. Under **Build and deployment**, set **Source** to **GitHub Actions**
#### Usage
```yml
name: "Swift Doc Deployment"
on: [push]
jobs:
deploy:
runs-on: macos-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.cicd.outputs.page-url }}
steps:
- uses: g1j0shi/swift-doc-deployment@main
id: cicd
```
#### Input
| Name | Description | Required | Default |
| ------ | --------------------------------------------------- | -------- | ------- |
| target | The Swift package target to generate documentation. | true | - |
#### Output
| Name | Description |
| -------- | ------------------------------------- |
| page-url | URL of the deployed GitHub Pages site |
#### Example
```yml
...
- uses: g1j0shi/swift-doc-deployment@main
id: cicd
with:
target: "SwiftPackage"
```