feat: add kebab-case support with.github-token

[DariuszPorowski]

Resolves #318

---

Behavior

Before the change?

• no support for kebab-case style for github token using with

After the change?

• add kebab-case style support with.github-token

Other information

• N/A

---

Additional info

Pull request checklist

• Tests for the changes have been added (for bug fixes / features)
• Docs have been reviewed and added / updated if needed (for bug fixes / features)
• Added the appropriate label for the given change no permission to do it ;)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

• Yes (Please add the Type: Breaking change label)
• No

If Yes, what's the impact:

• N/A

Pull request type

Please add the corresponding label for change this PR introduces:

• Bugfix: Type: Bug
• Feature/model/API additions: Type: Feature
• Updates to docs or samples: Type: Documentation
• Dependencies/code cleanup: Type: Maintenance

---

[gr2m]

Looks good, cheers 👍🏼

[gr2m]

Can you run npm run lint:fix to fix the linting errors? I don't seem to have write access to your fork, otherwise I'd have done it myself

[DariuszPorowski]

@gr2m hmm, interesting because PR is marked Allow edits by maintainers whatever... lint done :)

[gr2m]

@gr2m hmm, interesting because PR is marked Allow edits by maintainers whatever... lint done :)

probably my fault then. I used codespace on your fork, it wouldn't let me push 🤷🏼 Anyway, cheers1

[github-actions]

🎉 This PR is included in version 2.1.0 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

[gr2m]

Sorry it looks like it introduced a regression for users of github-script. Until we figure out what, I'll have to revert this change. See #320

[DariuszPorowski]

@gr2m oh! ok

[DariuszPorowski]

@gr2m just figured out:
actions/github-script uses with.github-token by default: https://github.com/actions/github-script/blob/main/action.yml#L11

so, I assume that the intention of the creators of the actions/github-script action is to use this for the tokens: ref: https://github.com/actions/github-script/tree/main#using-a-separate-github-token
actions/github-script is already pre-authenticated with Octokit using mentioned method: https://github.com/actions/github-script/blob/main/README.md?plain=1#L13
The issue #320 contains the code that does new own Octokit instance, which was probably not in line with the action's assumptions. Regardless of that, it's still possible but token should be utilized in the actions/github-script way like:
process.env['INPUT_GITHUB-TOKEN'] or using @actions/core (already include in this action: https://github.com/actions/github-script/blob/main/README.md?plain=1#L17): const token = core.getInput('github-token')

[gr2m]

how about this: instead of adding support for the github-token, we throw a helpful error message if neither token nor github_token is set, but github-token is?

[DariuszPorowski]

@gr2m sounds like kind of workaround... but before we jump into... just saw actions/github-script does not use @octokit/auth-action at all 😸 so it's a not root cause for #320. Example from this issue uses const { Octokit } = require("@octokit/action") so it utilize @octokit/action and it uses @octokit/auth-action. But even with that it's not a problem.
Problem starts when someone use @octokit/action inside actions/github-script and want to use own token in a different way that actions/github-script expose. Why? because actions/github-script already handle the token in with.github-token so it already inside the script, and @octokit/action can access it via @octokit/auth-action (assuming my PR is already there).
Going deeper, latest release of @octokit/action does not contain @octokit/auth-action v2.1.0 yet, so it should not fail (unless someone independently installs the latest @octokit/auth-action package).

Hypothetically if the actions/github-script action will use snake_case instead kebab-case the final effect will be the same with the current (before PR) @octokit/auth-action version.

[gr2m]

Ahh I see. Yeah the way @TCarrol import @octokit/action in the script is odd, as that's what the action does by default with the global github. I'll let them know

[DariuszPorowski]

Use case for @octokit/action what I see it's a bit different (https://github.com/octokit/action.js/blob/main/README.md?plain=1#L50) and makes sense, but @octokit/action inside actions/github-script looks like unnecessary overlap.

[DariuszPorowski]

Hey @gr2m just following up, do you think is it ok to reopen this pr?