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

Warn user is using deprecated default source (repository reference instead of default = true) #1355

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

noahd1
Copy link
Member

@noahd1 noahd1 commented Dec 20, 2024

We recently changed the default source for newly generated qlty.toml files from:

[[source]]
name = "default"
repository = "https://github.com/qltysh/qlty"
branch = "main"

to:

[[source]]
name = "default"
default = "true"

This was so that the plugins referenced, by default, are guaranteed to be compatible with the binary used, because the plugins are compiled into the binary.

This works for newly generated qlty.toml files, but old generated ones in the wild should, ideally, be updated. They will continue to work as is, and a repository source is still a valid way to load sources, however, it is inherently more susceptible to incompatability issues than default = true.

This PR adds a warning if using the old-style default source.

Warning looks like this currently:

image

@noahd1 noahd1 requested a review from brynary December 20, 2024 19:41
Copy link
Contributor

qltysh bot commented Dec 20, 2024

The code coverage on the diff in this pull request is 100.0%

Drilldown
Path File Coverage Δ
qlty-check/src/tool/github.rs 0.1
qlty-config/src/library.rs 0.7
qlty-check/src/parser/biome.rs 0.1
qlty-check/src/parser/trivy_sarif.rs 0.7
qlty-coverage/src/formats.rs 0.8
qlty-check/src/parser/phpstan.rs 0.8
qlty-check/src/parser/sqlfluff.rs 0.2
qlty-check/src/parser/knip.rs -0.1
qlty-coverage/src/publish/settings.rs 0.0
qlty-check/src/parser/markdownlint.rs 1.0
qlty-config/src/sources/git_source.rs 35.5
qlty-check/src/parser/php_codesniffer.rs 0.6
qlty-check/src/parser/sarif.rs 0.1
qlty-check/src/parser/radarlint.rs 0.7
qlty-config/src/workspace.rs 0.4
qlty-coverage/src/transform/settings.rs 0.0
qlty-analysis/src/code/file.rs 3.3
qlty-check/src/parser/rubocop.rs -0.2
qlty-check/src/parser/golangci_lint.rs 0.3
qlty-coverage/src/parser/jacoco.rs -1.3
qlty-check/src/parser/ripgrep.rs 0.6
qlty-check/src/parser/tsc.rs 1.1
qlty-check/src/parser/coffeelint.rs 0.7
qlty-check/src/parser/stylelint.rs 0.7
qlty-check/src/parser/actionlint.rs 1.0
qlty-check/src/parser/bandit.rs 0.7
qlty-check/src/parser/eslint.rs 0.2
qlty-config/src/config.rs 9.9
qlty-smells/src/duplication/code.rs 1.3
qlty-check/src/parser/ruff.rs 0.4
qlty-analysis/src/workspace_entries/target_mode.rs 33.3
qlty-check/src/parser/clippy.rs 0.5
qlty-check/src/parser/trufflehog.rs 1.3

Copy link
Contributor

qltysh bot commented Dec 20, 2024

All good ✅

qlty-config/src/workspace.rs Show resolved Hide resolved
qlty-config/src/config.rs Outdated Show resolved Hide resolved
noahd1 and others added 8 commits December 20, 2024 22:38
Fairly dumb refactoring, just splitting a big file down into more
smaller files with clearer inputs
Just the protobuf change in this one
On Windows, the output string is quoted. On Mac and Linux, it is not.
This snapshot hopefully works for both.
@noahd1 noahd1 enabled auto-merge (squash) December 22, 2024 02:29
@noahd1
Copy link
Member Author

noahd1 commented Dec 22, 2024

Addresssed comments / merged in main to get tests passing.

@noahd1 noahd1 disabled auto-merge December 23, 2024 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants