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

Change github-pat input name #209

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

saerosV
Copy link
Contributor

@saerosV saerosV commented Feb 18, 2023

What this PR does

Renames the github-pat input argument to github-token, as to better reflect the different kinds of tokens this input accepts, according to the changes made in #208.

@saerosV saerosV changed the title Change GitHub pat argument name Change github-pat input name Feb 18, 2023
Copy link
Contributor

@DuncanCasteleyn DuncanCasteleyn left a comment

Choose a reason for hiding this comment

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

Since no fall back is provided this is a breaking change.

Which means workflows using @master as target will break when merged into master.

README.md Outdated Show resolved Hide resolved
github-pat:
description: 'GitHub Personal Access Token (PAT) for submitting SBOM to GitHub Dependency Snapshot API'
github-token:
description: 'Authentication token to enable sending SBOM scan results to GitHub Dependency Graph. Can be either a GitHub Personal Access Token (PAT) or GITHUB_TOKEN'
required: false
Copy link
Contributor

@DuncanCasteleyn DuncanCasteleyn Feb 20, 2023

Choose a reason for hiding this comment

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

Suggested change
required: false
default: ${{ github.token }}

We could add this to make the configuration even simpler, not sure if that is a good idea, but it how it's done for https://github.com/actions/checkout/blob/main/action.yml for example.

Copy link
Contributor Author

@saerosV saerosV Mar 29, 2023

Choose a reason for hiding this comment

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

@simar7 do you think this should be part of the PR? Not part of the initial goals of the PR, but I think it is a good enough improvement to add.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ saerosV
❌ guilherme_marz


guilherme_marz seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

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

Successfully merging this pull request may close these issues.

3 participants