Skip to content
This repository has been archived by the owner on Feb 11, 2022. It is now read-only.

Commit

Permalink
fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
heowc committed Aug 15, 2019
1 parent 0280c74 commit 9b977fa
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This Action for hexo enables arbitrary actions with the hexo command-line client

An example workflow to clean, generate, and deploy an hexo to the default public registry follows:

### 1. HCL syntax (not recommend, [it will be deprecated on September 30, 2019](https://help.github.com/en/articles/migrating-github-actions-from-hcl-syntax-to-yaml-syntax#about-the-new-yaml-syntax-for-github-actions))

```hcl
workflow "Clean, Generate, and Deploy" {
on = "push"
Expand Down Expand Up @@ -34,6 +36,33 @@ action "Deploy" {
}
```

### 2. YAML syntax (recommed, [how to migration](https://help.github.com/en/articles/migrating-github-actions-from-hcl-syntax-to-yaml-syntax#converting-workflow-files-in-your-repository-to-yaml-syntax))

```yaml
on: push
name: Deploy
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Clean
uses: heowc/action-hexo@master
with:
args: clean
- name: Generate
uses: heowc/action-hexo@master
with:
args: generate
- name: Deploy
uses: heowc/action-hexo@master
env:
EMAIL: input emial ...
NAME: input name ...
with:
args: deploy

```
### Environment variables

If using `hexo-deployer-git` when `Deploy` action,
Expand Down

0 comments on commit 9b977fa

Please sign in to comment.