proposal: Create Tag on Commit

[cinderblock]

Is your feature request related to a problem? Please describe.
I'd like to tag specific versions of my gh-pages branch programmatically (in my case, based on package.json version)

Describe the solution you'd like
I'd like an option to add a tag with a specified name on commit.

Describe alternatives you've considered
Manually - PITA.

Additional context
I'm thinking I'd like to be able to use this like so:

- name: Tagged Deploy
  env:
    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
    PUBLISH_BRANCH: gh-pages
    PUBLISH_DIR: ./public
    CREATE_TAG: ${{ <expression> }}

Where expression might load some values from other steps or combine readily available job information.

Other options for forcing the overwrite of an existing tag or not might make sense too.

[peaceiris]

It sounds interesting. I will consider that option this weekend. (I'm busy now.)

[peaceiris]

My suggestion.

- name: Prepare deployment
  id: prepare_deployment
  run: |
    TAG_NAME="v$(jq -r '.version' ./package.json)"
    echo "::set-output name=tag_name::${TAG_NAME}"

- name: Tagged Deploy
  uses: peaceiris/actions-gh-pages@v2
  env:
    ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
    PUBLISH_BRANCH: gh-pages
    PUBLISH_DIR: ./public
  with:
    tagName: deploy-v${{ steps.prepare_deployment.outputs.tag_name }}

Other options for forcing the overwrite of an existing tag or not might make sense too.

Yes.

[cinderblock]

Yes, that's a good example of how this might be used.

[cinderblock]

Is there a reason you used env for most of the options but are suggesting with for this one?

[peaceiris]

The with statement can contain useful options like required and default. It is better to use with than env. This action has published when GitHub Actions was beta v1 and we had only env. I am going to move all env options under with. #54

actions-gh-pages/action.yml

Lines 11 to 14 in 37729f1

	emptyCommits:
	description: 'If empty commits should be made to the publication branch'
	required: false
	default: 'true'

[cinderblock]

Ah. Historical reasons make sense.

FYI, they implemented with by just having an env with prefix INPUT_:

https://github.com/actions/toolkit/blob/03ebc5b8851571a1ce55409097a52b1a74019e52/packages/core/src/core.ts#L60-L75

[peaceiris]

Go to #78

[github-actions]

This issue has been LOCKED because of it being resolved!

The issue has been fixed and is therefore considered resolved.
If you still encounter this or it has changed, open a new issue instead of responding to solved ones.

Log | Bot Usage