Skip to content

Remove ownerName and repositoryName from DistributionConfig #3183

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

Merged
merged 1 commit into from
Jan 3, 2024

Conversation

robertbrignull
Copy link
Contributor

As far as I can tell, these fields do not work. They aren't linked up to read values from the config, and setting "codeQL.cli.repositoryName": "foo" in your config does nothing.

This reason for this is because the only way these values are accessed is through the DistributionConfigListener class, which implements the DistributionConfig interface. That class does not define these fields and therefore they get their default value of undefined. The reason we didn't notice this earlier is because the field is allowed to be undefined. If you change the type to string | null then it produces an error.

Looking back in the history, I believe the intention was to fully remove these in #174 (see the comments on the linked internal issues) but for whatever reason that PR didn't remove all references and instead only marked them as maybe undefined. I'm a little confused by that, but I think that removing these final references does not change behaviour and is in the spirit of that earlier change.

Checklist

  • CHANGELOG.md has been updated to incorporate all user visible changes made by this pull request.
  • Issues have been created for any UI or other user-facing changes made by this pull request.
  • [Maintainers only] If this pull request makes user-facing changes that require documentation changes, open a corresponding docs pull request in the github/codeql repo and add the ready-for-doc-review label there.

@robertbrignull robertbrignull requested a review from a team January 2, 2024 17:08
@robertbrignull robertbrignull requested a review from a team as a code owner January 2, 2024 17:08
Copy link
Member

@koesie10 koesie10 left a comment

Choose a reason for hiding this comment

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

Thanks, LGTM!

@robertbrignull robertbrignull merged commit b27d8a1 into main Jan 3, 2024
@robertbrignull robertbrignull deleted the robertbrignull/remove_releases_repo_config branch January 3, 2024 09:46
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