actions-gh-pages

v2.5.0-rc0 for #36

Release v2.4.0

New feature - Keeping existing files

New option keepFiles by @RomanHotsiy #33 #34

By default, existing files in the publish branch are removed before adding the ones from publish dir. If you want the action to add new files but leave existing ones untouched, set the optional parameter keepFiles to true.

For example:

- name: Deploy
  uses: peaceiris/[email protected]
  env:
    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
    PUBLISH_BRANCH: gh-pages
    PUBLISH_DIR: ./public
  with:
    keepFiles: true

Test for #34

Bugfix

• #28

#28

#28

#28

Release v2.3.1

Bug fix

• Fix: git rm fails when publishing branch is empty (#24 by @blue-jam )

Release v2.3.0

New feature

Suppressing empty commits option. (#22 by @kingofzeal )

By default, a commit will always be generated and pushed to the PUBLISH_BRANCH, even if nothing changed. If you want to suppress this behavior, set the optional parameter emptyCommits to false. cf. Issue #21

For example:

- name: deploy
  uses: peaceiris/[email protected]
  env:
    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
    PUBLISH_BRANCH: gh-pages
    PUBLISH_DIR: ./public
  with:
    emptyCommits: false

Add workflow examples

• Repository type - User and Organization
• YAML workflow examples
  • Static Site Generators with Node.js
  • Gatsby
  • React and Next
  • Vue and Nuxt
  • Static Site Generators with Python (MkDocs)

Release v2.2.0 includes the following updates.

• add: PERSONAL_TOKEN
• update: readme about PERSONAL_TOKEN`

Create a personal access token (repo) and add it to Secrets as PERSONAL_TOKEN, it works as well as ACTIONS_DEPLOY_KEY.

- ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+ PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}

Release v2.1.0 includes the following updates.

• change: base docker image from ubuntu:18.04 to alpine:3.10.2

Release v2.0.0 includes the following updates.

• Migrate: from v1 to GitHub Actions v2 (HCL to YAML)
• Update: the YAML file examples (Hugo and MkDocs)
• Add: fetch a remote branch before deploying (#7 by @MikaelSmith )
• Add: action public docker image on Docker Hub
  • peaceiris/gh-pages - Docker Hub

Release v1.1.0 (#4)

• change: use GITHUB_TOKEN instead of ACTIONS_DEPLOY_KEY

Fix: shellcheck errors