Jazzy Swift Docs
ActionsTags
(2)A GitHub Action to generate and publish Jazzy documentation for your Swift and/or Objective-C projects.
This Action expects the following to be true:
- Your workflow runs on macOS
- You have documentation comments present in your Swift/Objective-C project (otherwise you will be generating a pretty useless website)
- You have a
gh-pagesbranch in your repository - A personal access token with
reposcope. TheGITHUB_TOKENavailable as part of an action will not trigger a Github Pages build. See this discussion thread for more information.
| Key | Description | Required |
|---|---|---|
personal_access_token |
A personal access token with repo scope for pushing documentation to gh-pages branch. See Creating a Personal Access Token for creating the token and Creating and Using Secrets for including secrets to be used in tandem with Github Actions. |
Yes |
config |
The path to a Jazzy yaml or json configuration file | No |
args |
Command line arguments to be passed to Jazzy. See jazzy --help on your local machine for available options |
No |
version |
The Jazzy version to run. Defaults to latest | No |
branch |
Branch to deploy on - default: gh-pages | No |
history |
Maintain branch history - default: true | No |
Documentation generation can be as minimal as the following:
name: PublishDocumentation
on:
release:
types: [published]
jobs:
deploy_docs:
runs-on: macos-latest
steps:
- uses: actions/checkout@v1
- name: Publish Jazzy Docs
uses: steven0351/publish-jazzy-docs@v1
with:
personal_access_token: ${{ secrets.ACCESS_TOKEN }}Specify a Jazzy config file:
...
- name: Publish Jazzy Docs
uses: steven0351/publish-jazzy-docs@v1
with:
personal_access_token: ${{ secrets.ACCESS_TOKEN }}
config: .jazzy.ymlPass CLI args:
...
- name: Publish Jazzy Docs
uses: steven0351/publish-jazzy-docs@v1
with:
personal_access_token: ${{ secrets.ACCESS_TOKEN }}
args: "--theme fullwidth --author Johnny Appleseed"Specify a Jazzy version:
...
- name: Publish Jazzy Docs
uses: steven0351/publish-jazzy-docs@v1
with:
personal_access_token: ${{ secrets.ACCESS_TOKEN }}
version: 0.11.2Pull requests are the preferred method of contributing. If you are unable to create a pull request, a detailed GitHub Issue describing the bug or feature request is more than welcome.
Jazzy Swift Docs is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
About
Tags
(2)Jazzy Swift Docs is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.