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

feat: add WIF docs, add warning for credentials input #141

Merged
merged 11 commits into from
Nov 15, 2021
Merged

Conversation

bharathkkb
Copy link
Contributor

@bharathkkb bharathkkb commented Nov 13, 2021

  • Add warning for credentials input
  • Remove credentials section and add WIF
  • Update example workflows to use auth

.github/workflows/get-gke-credentials-it.yml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
src/main.ts Outdated
// Add warning if using credentials
if (credentials) {
core.warning(
'"credentials" input has been deprecated and will be removed in a future release. ' +
Copy link
Member

Choose a reason for hiding this comment

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

I don't know if we should say "will be removed in a future release". It would be better to highlight the benefits of using the auth action for now, and then add the "deprecation" in a few releases.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed that bit- I also have a link in there that points to the relevant section in the main readme which expands on the benefits of using auth.

Copy link
Member

Choose a reason for hiding this comment

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

Okay - I'm just a little worried about using the "deprecated" word here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Since we plan to remove this at some point, I think deprecated would encourage more folks to use auth. Happy to switch if you have anything particular in mind.

bharathkkb and others added 2 commits November 13, 2021 16:32
Co-authored-by: Seth Vargo <seth@sethvargo.com>
README.md Outdated Show resolved Hide resolved
src/main.ts Outdated
// Add warning if using credentials
if (credentials) {
core.warning(
'"credentials" input has been deprecated and will be removed in a future release. ' +
Copy link
Member

Choose a reason for hiding this comment

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

Okay - I'm just a little worried about using the "deprecated" word here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants