Skip to content

Commit

Permalink
Add support for args+config, history, user-defined branch, and fix bu…
Browse files Browse the repository at this point in the history
…gs (#17)

* Add support for args+config, history, user-defined branch, and fix bugs

Add support for both args and config file

Add bundle

Update to using dist/index.js

Fix errors. Fix jazzy version.

Fix errors. Fix jazzy version.
Add support for changing branches
Add support for git history
Add support for both args and a config file.
Remove support for '--source-directory' arg

Remove null coalescing operator

Fix shell config error

Fix command order

Fix defaults

Add logger

Use staging folder

fix typeo

build

build

Fix .staging

Add -p flag to make parent dirs

Fix move destination

Create directory before second move

Prevent nesting

Force remove if docs exist

Remove logs, Update README with changes

* Fix #6 leak build info

* ammend
  • Loading branch information
marzvrover authored Dec 9, 2020
1 parent 3d5e841 commit 7afe6c5
Show file tree
Hide file tree
Showing 691 changed files with 24,153 additions and 110,816 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ bower_components
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
Expand Down
21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,18 @@ This Action expects the following to be true:
|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](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token#creating-a-token) for creating the token and [Creating and Using Secrets](https://help.github.com/en/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) 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 |
| `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

## Limitations
This Action will never support the following:
* Generating and deploying documentation to `master` or in a docs folder on `master`
* Maintain commit history of the `gh-pages` branch.

This Action does not currently support the following:
* Specifying both `config` and `args`. Any `args` provided along with `config` will be ignored.
| `branch` | Branch to deploy on - default: gh-pages | No |
| `history` | Maintain branch history - default: true | No

## Usage
Documentation generation can be as minimal as the following:
```yaml
name: PublishDocumentation

on:
on:
release:
types: [published]

Expand Down
14 changes: 10 additions & 4 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
name: "Publish Jazzy Docs"
description: "Generate Swift/Objective-C documentation with Jazzy and publish to Github Pages"
inputs:
branch:
description: "Branch to deploy on - default: gh-pages"
required: false
history:
description: "Maintain branch history - default: true"
required: false
config:
description: "Path to .jazzy.yml file - preferred"
description: "Path to .jazzy.yml file."
required: false
args:
description: "Arguments to pass to Jazzy"
description: "Arguments to pass to Jazzy."
required: false
version:
description: "Jazzy Version"
Expand All @@ -15,7 +21,7 @@ inputs:
required: true
runs:
using: "node12"
main: "main.js"
main: "dist/index.js"
branding:
icon: "book"
color: "green"
color: "green"
File renamed without changes.
Loading

0 comments on commit 7afe6c5

Please sign in to comment.