Skip to content

Commit 7afe6c5

Browse files
authored
Add support for args+config, history, user-defined branch, and fix bugs (#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
1 parent 3d5e841 commit 7afe6c5

File tree

691 files changed

+24153
-110816
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

691 files changed

+24153
-110816
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ bower_components
3333
build/Release
3434

3535
# Dependency directories
36+
node_modules/
3637
jspm_packages/
3738

3839
# TypeScript v1 declaration files

LICENSE

Lines changed: 0 additions & 21 deletions
This file was deleted.

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,18 @@ This Action expects the following to be true:
1212
|Key|Description|Required|
1313
|---|---|:---:|
1414
| `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 |
15-
| `config` | The path to a Jazzy yaml or json configuration file| No |
16-
| `args` | Command line arguments to be passed to Jazzy. See `jazzy --help` on your local machine for available options| No |
15+
| `config` | The path to a Jazzy yaml or json configuration file | No |
16+
| `args` | Command line arguments to be passed to Jazzy. See `jazzy --help` on your local machine for available options | No |
1717
| `version` | The Jazzy version to run. Defaults to latest | No
18-
19-
## Limitations
20-
This Action will never support the following:
21-
* Generating and deploying documentation to `master` or in a docs folder on `master`
22-
* Maintain commit history of the `gh-pages` branch.
23-
24-
This Action does not currently support the following:
25-
* Specifying both `config` and `args`. Any `args` provided along with `config` will be ignored.
18+
| `branch` | Branch to deploy on - default: gh-pages | No |
19+
| `history` | Maintain branch history - default: true | No
2620

2721
## Usage
2822
Documentation generation can be as minimal as the following:
2923
```yaml
3024
name: PublishDocumentation
3125

32-
on:
26+
on:
3327
release:
3428
types: [published]
3529

action.yml

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
name: "Publish Jazzy Docs"
22
description: "Generate Swift/Objective-C documentation with Jazzy and publish to Github Pages"
33
inputs:
4+
branch:
5+
description: "Branch to deploy on - default: gh-pages"
6+
required: false
7+
history:
8+
description: "Maintain branch history - default: true"
9+
required: false
410
config:
5-
description: "Path to .jazzy.yml file - preferred"
11+
description: "Path to .jazzy.yml file."
612
required: false
713
args:
8-
description: "Arguments to pass to Jazzy"
14+
description: "Arguments to pass to Jazzy."
915
required: false
1016
version:
1117
description: "Jazzy Version"
@@ -15,7 +21,7 @@ inputs:
1521
required: true
1622
runs:
1723
using: "node12"
18-
main: "main.js"
24+
main: "dist/index.js"
1925
branding:
2026
icon: "book"
21-
color: "green"
27+
color: "green"
File renamed without changes.

0 commit comments

Comments
 (0)