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

OIDC examples don't pin external actions (& don't declare them) #34316

Open
1 task done
janbrasna opened this issue Aug 15, 2024 · 5 comments
Open
1 task done

OIDC examples don't pin external actions (& don't declare them) #34316

janbrasna opened this issue Aug 15, 2024 · 5 comments
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue SME reviewed An SME has reviewed this issue/PR

Comments

@janbrasna
Copy link
Contributor

@janbrasna janbrasna added the content This issue or pull request belongs to the Docs Content team label Aug 15, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Aug 15, 2024
@janbrasna
Copy link
Contributor Author

Or do I remember it wrong and it's mandatory only in starter-workflows …?

@nguyenalex836 nguyenalex836 added actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Aug 15, 2024
@nguyenalex836
Copy link
Contributor

@janbrasna Thanks so much for opening an issue!

Or do I remember it wrong and it's mandatory only in starter-workflows …?

We'll get to the bottom of this during review! ✨

@nguyenalex836 nguyenalex836 added the needs SME This proposal needs review from a subject matter expert label Aug 15, 2024
Copy link
Contributor

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀

@janbrasna
Copy link
Contributor Author

it's definitely here:

  • {% data reusables.actions.actions-not-certified-by-github %}
  • {% data reusables.actions.actions-use-sha-pinning %}

and definitely being used e.g. in docker examples… but now i can't seem to be able to locate any guidelines for that in the style guide or writing examples.

@nguyenalex836
Copy link
Contributor

@janbrasna Thank you for your patience while our engineering team reviewed this issue! They responded with the following -

... touching on a general concern where a maintainer of an action can change what the v2 branch or v2.1.5 tag points to. By pointing to a specific commit SHA, you can be confident exactly what you're getting regardless of what ever else the maintainers do. This comes at the cost of needing to keep these versions updated as the maintainers create new releases.

... there are trade offs in both approaches, more security or ease of managing upgrades. Users who want can try to get a balance of both by using SHAs and turning on Dependabot to open PRs when never versions are available.

Still, I don’t know if we want to align all of GitHub docs purely on SHA pinning or not. Directing users to the links above about considerations is my preference.

Let us know if you have any thoughts regarding the above! For now, I'll add the help wanted label to this issue so that you, or anyone else, can make these updates 💛

@nguyenalex836 nguyenalex836 added SME reviewed An SME has reviewed this issue/PR help wanted Anyone is welcome to open a pull request to fix this issue and removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue SME reviewed An SME has reviewed this issue/PR
Projects
None yet
Development

No branches or pull requests

2 participants