From f5a4689a003c5c6f2d1619398d7ea6750d57178f Mon Sep 17 00:00:00 2001 From: James Ives Date: Wed, 21 Aug 2019 11:21:45 -0400 Subject: [PATCH] Update README.md --- README.md | 25 ++----------------------- 1 file changed, 2 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 3be80e1a..692b3dfb 100644 --- a/README.md +++ b/README.md @@ -7,30 +7,9 @@ This [GitHub action](https://github.com/features/actions) will handle the buildi ❗️**You can find instructions for using version 1 of the GitHub Actions workflow format [here](https://github.com/JamesIves/github-pages-deploy-action/tree/1.1.3).** ## Getting Started :airplane: -You can include the action in your workflow to trigger on any event that [GitHub actions](https://github.com/features/actions) supports. If the remote branch that you wish to deploy to doesn't already exist the action will create it for you. +You can include the action in your workflow to trigger on any event that [GitHub actions](https://github.com/features/actions) supports. If the remote branch that you wish to deploy to doesn't already exist the action will create it for you. Your workflow will also need to include the `actions/checkout` step before this workflow runs in order for the deployment to work. -Your workflow will also need to include the `actions/checkout` step before this workflow runs in order for the deployment to work. You can view an example of this below. - -```yml -name: Build and Deploy -on: [push] -jobs: - build-and-deploy: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@master - - - name: Build and Deploy - uses: JamesIves/github-pages-deploy-action@master - env: - ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }} - BRANCH: gh-pages - FOLDER: build - BUILD_SCRIPT: npm install && npm run-script build -``` - -You can combine it with the filter action so it only triggers deploys on a specific branch. +You can view an example of this below. ```yml name: Build and Deploy