Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Providing instructions for self hosted solutions #55

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

James712346
Copy link

When running this action in gitea, or another CI/CD based off github action, this will produce a ::error::Bad credentials error. Therefore this can be fixed by setting local environment, INPUT_TOKEN, to a user generated GitHub token key
image

@CLAassistant
Copy link

CLAassistant commented May 10, 2023

CLA assistant check
All committers have signed the CLA.

@James712346
Copy link
Author

Image showing the action now working with the environment set
image

Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your PR @James712346!

The standard approach for setting the token is to use the action's token input:

Unfortunately the action's author never wrote user friendly documentation of the inputs so currently the user would need to study the action.yml metadata file to learn of the existence of this input.

Rather than document the input in the context of this specific use case, it will be better to instead provide a general reference to the action's inputs. This information will be applicable to all contexts. You can use the inputs documentation of this similar action as a model for how to write the documentation in the standardized format used in Arduino's GitHub Actions actions:

https://github.com/arduino/setup-task/blob/main/README.md?plain=1#L18

@per1234 per1234 added topic: documentation Related to documentation for the project type: enhancement Proposed improvement labels May 11, 2023
@James712346
Copy link
Author

Haha, I did look at action.yaml when debugging this issue and missed that definition, and didn't even think about, INPUT_TOKEN would be defined in there. At the time I thought it was pretty weird, to have gitHub.token as INPUT_TOKEN in the js code. But it all makes sense now

To be fair to me, I was pretty tried when I did this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants