Skip to content

Commit

Permalink
Use inputs (with) instead of variables.
Browse files Browse the repository at this point in the history
  • Loading branch information
ArnaudLigny committed Dec 11, 2020
1 parent 77e39cf commit c507c0c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,33 +10,32 @@

See [action.yml](action.yml).

**Workflow example:**

```yml
name: GitHub Pages deploy
on:
push:
branches:
- master

jobs:
checkout-and-deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v2

- name: Deploy to GitHub Pages
uses: Cecilapp/GitHub-Pages-deploy@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
EMAIL: arnaud@ligny.org
BUILD_DIR: _site
with:
email: arnaud@ligny.org
build_dir: _site
```
### Configuration
- `EMAIL` (required): A - verified - email
- `BUILD_DIR` (required): Where static/public files are (`_site` by default)
- `CNAME`: The custom domain name (ie: `narno.com`)
- `JEKYLL_SITE`: Set `YES` in case of a [Jekyll](https://jekyllrb.com) site (`NO` by default)

## License
_GitHub Pages deploy_ is a free software distributed under the terms of the MIT license.
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: 'GH Pages deploy'
description: 'A GitHub Action to deploy a static site on GitHub Pages.'
description: 'This deploys a static site on GitHub Pages.'
author: 'Arnaud Ligny'
inputs:
email:
Expand Down

0 comments on commit c507c0c

Please sign in to comment.