feat: Add tagName and tagMessage options

[peaceiris]

Close #76

• Update readme.md

[peaceiris]

Workflow Example

• repo: https://github.com/peaceiris/nextjs-test
• workflow file: https://github.com/peaceiris/nextjs-test/blob/v0.1.4/.github/workflows/gh-pages.yml
• Action log: https://github.com/peaceiris/nextjs-test/commit/4ac6756c30a8ed4f487bee139b40cfbcb29d5731/checks
• tags: https://github.com/peaceiris/nextjs-test/tags

YAML file:

name: github pages

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

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

    - name: setup node
      uses: actions/setup-node@v1
      with:
        node-version: '12.x'

    - name: Get yarn cache
      id: yarn-cache
      run: echo "::set-output name=dir::$(yarn cache dir)"

    - uses: actions/cache@v1
      with:
        path: ${{ steps.yarn-cache.outputs.dir }}
        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
        restore-keys: |
          ${{ runner.os }}-yarn-

    - run: yarn install
    - run: yarn build
    - run: yarn export
    - run: touch ./out/.nojekyll

    - 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.10.0-0
      # uses: docker://peaceiris/gh-pages:v2.10.0-0
      env:
        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
        PUBLISH_BRANCH: gh-pages
        PUBLISH_DIR: ./out
      with:
        tagName: ${{ steps.prepare_tag.outputs.deploy_tag_name }}
        tagMessage: 'Deployment ${{ steps.prepare_tag.outputs.tag_name }}'

Commands on a local machine

npm version patch  # Create a tag v0.1.4

git push origin master
# A job triggered by a "branches push event" starts.
# Wait a second for a job triggered by a "branches push event" to prevent a conflict with the next job.

git push origin v0.1.4  # push the tag v0.1.4
# A job triggered by a "tags push event" starts.

$ git fetch
$ git tag
deploy-v0.1.3
deploy-v0.1.4
v0.1.3
v0.1.4

We can also push tags as follows.

git push origin --tags
# OR
git push origin "v$(jq -r '.version' ./package.json)"

[peaceiris]

@cinderblock
Please test peaceiris/actions-gh-pages@v2.10.0-0.

[cinderblock]

Nicely done! Haven't had time to test yet. What about an option to force/replace an existing tag?

[peaceiris]

Do you have any use cases of force/replace options? I have no idea and it looks dangerous for me.

[cinderblock]

Maybe a mistake was made an someone wants to replace a wrong tag.

Yes, it is "dangerous", and that's why it should not be enabled by default. But it should be an option.

It's just the --force option on git tag.

[peaceiris]

Add tagOverwrite: true to peaceiris/actions-gh-pages@v2.10.0-1.

[peaceiris]

v2.10.0 has been released and the stable tag v2 updated.
Thank you!

https://github.com/peaceiris/actions-gh-pages/releases/tag/v2.10.0