github-push-action icon indicating copy to clipboard operation
github-push-action copied to clipboard

Consider renaming input from 'github_token' to 'github-token'?

Open matthewfeickert opened this issue 5 years ago • 1 comments

Hi! Today I was trying to play around with some updates using github-push-action and I noticed I was getting the error:

##[warning]Unexpected input 'github-token', valid inputs are ['github_token', 'repository', 'branch', 'force', 'tags', 'directory']

I was quite confused by this until I read closer and noticed that I had used github-token in

- name: Push changes
  uses: ad-m/[email protected]
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}

instead of github_token

- name: Push changes
  uses: ad-m/[email protected]
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}

As the GitHub github-script action uses github-token, would you consider changing the input to match them? My library is probably not the only one that uses both github-script and github-push-action so it would probably lead to less typos and errors. If there was a reason that you intentionally chose to not copy them then my apologies for missing this.

I also just wanted to say thank you, as your GitHub Action is awesome and we use it quite heavily in our publication workflow for our library pyhf.

matthewfeickert avatar May 30 '20 01:05 matthewfeickert

I do not feel comfortable to drop "github_token" support, but I will gladly accept PR, which will simultaneously introduce support for "github-token" with an indication of the recommended solution consistent with proposd.

ad-m avatar May 30 '20 15:05 ad-m