https://github.com/sersoft-gmbh/swifty-docs-action

A GitHub Action that generates documentation for a Swift package using docc.
https://github.com/sersoft-gmbh/swifty-docs-action

docc github-actions swift xcode

Last synced: 8 months ago
JSON representation

A GitHub Action that generates documentation for a Swift package using docc.

• Host: GitHub
• URL: https://github.com/sersoft-gmbh/swifty-docs-action
• Owner: sersoft-gmbh
• License: apache-2.0
• Created: 2020-04-19T15:00:30.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2025-06-30T06:39:33.000Z (9 months ago)
• Last Synced: 2025-06-30T14:48:33.624Z (9 months ago)
• Topics: docc, github-actions, swift, xcode
• Language: TypeScript
• Homepage:
• Size: 540 KB
• Stars: 12
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Swift Package Documentation Generator

[![Tests](https://github.com/sersoft-gmbh/swifty-docs-action/actions/workflows/tests.yml/badge.svg)](https://github.com/sersoft-gmbh/swifty-docs-action/actions/workflows/tests.yml)

This action generates documentation for a Swift package using `docc`.

**Important:** The package must use the [Swift-DocC Plugin](https://github.com/apple/swift-docc-plugin) unless `xcodebuild` is used!

**Note:** As of version 2, this action uses `docc` instead of `jazzy`! Use `@v1` to use `jazzy`. 

## Inputs

See [action.yml](action.yml) for all inputs.

## Example Usage

Use the following snippet in a Swift package repository to generate documentation for all products of your Swift package:

```yaml

uses: sersoft-gmbh/swifty-docs-action@v3

with:

  output: docs

```