Release v2.10.2-0

Pre-release v2.10.2-0 for #82

Release v2.10.1

deps: bump alpine from 3.11.2 to 3.11.3

Release v2.10.0

New Feature

New options tagName, tagMessage, and tagOverwrite.
Suggested by @cinderblock #76 #78

Here is an example workflow.

name: github pages

on:
  push:
    branches:
    - master
    tags:
    - 'v*.*.*'

jobs:
  build-deploy:
    runs-on: ubuntu-18.04
    steps:
    - uses: actions/checkout@v2

    - name: Some build

    - name: Prepare tag
      id: prepare_tag
      if: startsWith(github.ref, 'refs/tags/')
      run: |
        TAG_NAME="${GITHUB_REF##refs/tags/}"
        echo "::set-output name=tag_name::${TAG_NAME}"
        echo "::set-output name=deploy_tag_name::deploy-${TAG_NAME}"

    - name: Deploy
      uses: peaceiris/actions-gh-pages@v2
      env:
        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
        PUBLISH_BRANCH: gh-pages
        PUBLISH_DIR: ./public
      with:
        tagName: ${{ steps.prepare_tag.outputs.deploy_tag_name }}
        tagMessage: 'Deployment ${{ steps.prepare_tag.outputs.tag_name }}'

Commands on a local machine.

$ # On the master branch
$ git tag -a "v1.2.3" -m "Release v1.2.3"
$ git push origin "v1.2.3"

$ # After deployment
$ git fetch origin
$ git tag
deploy-v1.2.3  # Tag on the gh-pages branch
v1.2.3         # Tag on the master branch

We can set tagOverwrite option to true for overwriting a tag.

Pre-release v2.10.0-1

Pre-release v2.10.0-1 for #78

Pre-release v2.10.0-0

Pre-release v2.10.0-0 for #78

GitHub Pages Action v2.9.0

Release v2.9.0

New Feature

Custom commit message option #75

When we create a commit with a message docs: Update some post, a deployment commit will be generated with a message docs: Update some post ${GITHUB_SHA}.

- name: Deploy
  uses: peaceiris/actions-gh-pages@v2
  env:
    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
    PUBLISH_BRANCH: gh-pages
    PUBLISH_DIR: ./public
  with:
    commitMessage: ${{ github.event.head_commit.message }}

Suggested by @fabiosangregorio #72 #73 #74

Fixes

Add a linkable commit hash for external repository deployment. #73

Mentioned by @fabiosangregorio #72

GitHub Pages Action v2.9.0-0

Pre-release for #75

GitHub Pages Action v2.8.1-0

Pre-release for #73

GitHub Pages Action v2.8.0

Release v2.8.0

New Feature

Custom Git username and email #67

Set custom git config user.name and git config user.email.
A commit is always created with the same user.

- name: Deploy
  uses: peaceiris/actions-gh-pages@v2
  env:
    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
    PUBLISH_BRANCH: gh-pages
    PUBLISH_DIR: ./public
  with:
    username: "iris"
    useremail: "[email protected]"

cf. Comparing v2.7.0...v2.8.0 · peaceiris/actions-gh-pages

Pre-release v2.8.0-0

Pre-release v2.8.0-0 of #67