sersoft-gmbh/Swift Package Documentation Generator
Generates documentation for a Swift package using docc.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| package-path | The path to the package. | yes | ${{ github.workspace }} |
| package-version | The version to use for this package. | no | — |
| enable-inherited-docs | Whether to enable inherited docs. | yes | false |
| enable-index-building | Enables index building. | yes | false |
| platform | Specify information about the current release of a platform. See docc `--platform`. | no | — |
| checkout-path | The root path of the repository's checkout. Defaults to the workspace. | no | ${{ github.workspace }} |
| repository-service | The service to use for the repository. Must be supported by docc. Defaults to GitHub. | no | github |
| repository-base-url | The base URL of the repository. Defaults to the current repository. | no | ${{ github.server_url }}/${{ github.repository }}/blob/${{ github.ref || github.sha }} |
| transform-for-static-hosting | Enables the static hosting transformation. | yes | false |
| hosting-base-path | The hosting base path to use. | no | — |
| other-docc-arguments | Further (newline-separated) docc arguments. | no | — |
| targets | A list of targets separated by newline. If not given, all targets are built. Ignored if `use-xcodebuild` is `true`. | no | — |
| disable-automatic-documentation-combination | If not set, this action will automatically use `enable-experimental-combined-documentation` if more than one target is passed. Ignored if `use-xcodebuild` is `true`. | yes | false |
| use-xcodebuild | Tells the action to use xcodebuild (instead of `swift package`). Use `xcodebuild-scheme` and `xcodebuild-destination` to further customize the xcodebuild invocation. | yes | false |
| xcodebuild-scheme | The scheme to use for the xcodebuild invocation. Required if `use-xcodebuild` is true. | no | — |
| xcodebuild-destination | The destination to use for the xcodebuild invocation. Required if `use-xcodebuild` is true. | no | — |
| other-xcodebuild-arguments | Further (newline-separated) xcodebuild arguments. | no | — |
| output | The path to the output folder. | no | — |
Outputs
no outputs