Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0xwdg/build-documentation
The Swift Package Documentation Generator GitHub Action generates documentation for a Swift package using docc.build-documentation test
https://github.com/0xwdg/build-documentation
actions documentation generator github github-actions package swift
Last synced: 24 days ago
JSON representation
The Swift Package Documentation Generator GitHub Action generates documentation for a Swift package using docc.build-documentation test
- Host: GitHub
- URL: https://github.com/0xwdg/build-documentation
- Owner: 0xWDG
- Created: 2024-06-12T11:30:47.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-07-28T11:43:26.000Z (4 months ago)
- Last Synced: 2024-10-04T16:23:50.958Z (about 1 month ago)
- Topics: actions, documentation, generator, github, github-actions, package, swift
- Homepage:
- Size: 57.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Swift Package Documentation Generator
The Swift Package Documentation Generator GitHub Action generates documentation for a Swift package using docc.
```yaml
jobs:
Build-documentation:
runs-on: macos-latest
steps:
- name: Build documentation
uses: 0xWDG/build-documentation@main
```
|Parameter|Description|Default value|
|---|---|---|
|product|Product name|\_\_AUTO\_\_|
|temppath|Temporary Directory to write to|tmpdocs|
|branch|Branch to write to|documentation|
|ios|Should we build for iOS?|false|
```yaml
# .github/workflows/build-documentation.yml
name: build-documentation
on:
# Run on push to main branch
push:
branches:
- main
# Dispatch if triggered using Github (website)
workflow_dispatch:
jobs:
Build-documentation:
runs-on: macos-latest
steps:
- name: Build documentation
uses: 0xWDG/build-documentation@main
with:
product: Product-Name
temppath: tmpdocs
branch: documentation
iOS: false # Build for iOS
```