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

Include registry type in proxy_urls output #2672

Merged
merged 2 commits into from
Jan 8, 2025

Conversation

mbg
Copy link
Member

@mbg mbg commented Jan 6, 2025

This is a follow-up to #2652 to include the registry type in the proxy_urls output. Since private registry configurations are org-wide, we may end up with registry configurations in a given workflow run that are not relevant to the particular language being analysed. Including the feed type in the list of configured registries allows extractors to identify the ones that relevant to them.

@mbg mbg marked this pull request as ready for review January 7, 2025 12:05
@Copilot Copilot bot review requested due to automatic review settings January 7, 2025 12:05
@mbg mbg requested a review from a team as a code owner January 7, 2025 12:05
@mbg
Copy link
Member Author

mbg commented Jan 7, 2025

CI failures appear to be unrelated.

Choose a reason for hiding this comment

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

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

lib/start-proxy-action.js:158

  • Ensure that the type field in credential objects is always defined and correctly populated. If it can be undefined, handle it appropriately.
type: credential.type,

Tip: Copilot code review supports C#, Go, Java, JavaScript, Markdown, Python, Ruby and TypeScript, with more languages coming soon. Learn more

@aeisenberg
Copy link
Contributor

CI failures appear to be unrelated.

CI will be passing with the release of v2.20.1 of the CLI.

Comment on lines +177 to +180
.map((credential) => ({
type: credential.type,
url: credential.url,
}));
Copy link
Contributor

Choose a reason for hiding this comment

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

This changes the shape of the proxy_urls output. Previously, it was just an array of strings. Is there anything that consumes proxy_urls that will break because of this change?

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't think so. I only added this before Christmas for a feature I am working on, and I don't expect anyone else to be using it yet. This action is also marked as experimental, so I wouldn't worry about this potentially being a breaking change externally.

@aeisenberg
Copy link
Contributor

Also, maybe the description of the output should be updated as well? https://github.com/github/codeql-action/blob/main/start-proxy/action.yml#L27.

@mbg mbg merged commit fb65b6c into main Jan 8, 2025
266 of 269 checks passed
@mbg mbg deleted the mbg/start-proxy/include-type-in-urls-output branch January 8, 2025 18:30
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.

2 participants