Skip to content

ci: add GitHub token permissions for workflows#17781

Merged
TravisEz13 merged 1 commit intoPowerShell:masterfrom
varunsh-coder:token-perms
Aug 4, 2022
Merged

ci: add GitHub token permissions for workflows#17781
TravisEz13 merged 1 commit intoPowerShell:masterfrom
varunsh-coder:token-perms

Conversation

@varunsh-coder
Copy link
Copy Markdown
Contributor

@varunsh-coder varunsh-coder commented Jul 26, 2022

PR Summary

This PR adds minimum token permissions for the GITHUB_TOKEN in GitHub Actions workflows using https://github.com/step-security/secure-workflows.

PR Context

GitHub recommends defining minimum GITHUB_TOKEN permissions for securing GitHub Actions workflows

This project is part of the top 100 critical projects as per OpenSSF (https://github.com/ossf/wg-securing-critical-projects), so fixing the token permissions to improve security.

Before the change:
GITHUB_TOKEN has write permissions for multiple scopes, e.g.
https://github.com/PowerShell/PowerShell/runs/7530874225?check_suite_focus=true#step:1:19

After the change:
GITHUB_TOKEN will have minimum permissions needed for the jobs.

Signed-off-by: Varun Sharma varunsh@stepsecurity.io

PR Checklist

@ghost
Copy link
Copy Markdown

ghost commented Jul 26, 2022

CLA assistant check
All CLA requirements met.

@ghost
Copy link
Copy Markdown

ghost commented Aug 3, 2022

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@TravisEz13
Copy link
Copy Markdown
Member

@varunsh-coder Can you rebase your branch?

@ghost ghost removed the Review - Needed The PR is being reviewed label Aug 3, 2022
@TravisEz13

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

Signed-off-by: Varun Sharma <varunsh@stepsecurity.io>
@pull-request-quantifier-deprecated
Copy link
Copy Markdown

This PR has 41 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Small
Size       : +41 -0
Percentile : 16.4%

Total files changed: 8

Change summary by file extension:
.yml : +41 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@varunsh-coder
Copy link
Copy Markdown
Contributor Author

@varunsh-coder Can you rebase your branch?

Done

@TravisEz13
Copy link
Copy Markdown
Member

/azp run PowerShell-CI-windows

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

@TravisEz13
Copy link
Copy Markdown
Member

/remind me tomorrow

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Aug 4, 2022

@TravisEz13 set a reminder for 8/5/2022

@TravisEz13 TravisEz13 added the CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log label Aug 4, 2022
@TravisEz13 TravisEz13 self-assigned this Aug 4, 2022
@TravisEz13 TravisEz13 merged commit 65b83e9 into PowerShell:master Aug 4, 2022
@TravisEz13
Copy link
Copy Markdown
Member

@varunsh-coder Thanks for your contribution.

@ghost
Copy link
Copy Markdown

ghost commented Aug 11, 2022

🎉v7.3.0-preview.7 has been released which incorporates this pull request.:tada:

Handy links:

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

Labels

CL-BuildPackaging Indicates that a PR should be marked as a build or packaging change in the Change Log Extra Small reminder

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants