refactor: lint #3776
Merged
refactor: lint #3776
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
✅ Deploy Preview for zarf-docs canceled.
|
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
Codecov ReportAttention: Patch coverage is
... and 1 file with indirect coverage changes 🚀 New features to boost your workflow:
|
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
AustinAbro321
commented
May 12, 2025
hack/lint-all-zarf-packages.sh
Outdated
There was a problem hiding this comment.
Deleting this as I introduced this script alongside the zarf dev lint command, and have not used the script since. Additionally, because zarf dev lint now forces uses to define package templates (this behavior is consistent with zarf package create) the script will break on packages with templates
mkcp
requested changes
May 12, 2025
src/internal/packager2/lint.go
Outdated
| ) | ||
|
|
||
| // Lint lints the given Zarf package | ||
| func Lint(ctx context.Context, packagePath, flavor string, setVariables map[string]string) error { |
There was a problem hiding this comment.
blocking: packagePath appears to be a required param here, i'd recommend checking if the path is empty string (and, even better, checking if isn't a valid path) and providing a semantic error to the user if so.
There was a problem hiding this comment.
Added an empty check to packagePath. IMO it's better to leave the valid path checks to the os package. It will be caught right away.
| return err | ||
| } | ||
|
|
||
| // [DEPRECATION] Set the Package Variable syntax as well for backward compatibility |
| // LintError represents an error containing lint findings. | ||
| // | ||
| //nolint:revive // ignore name | ||
| type LintError struct { |
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
nevinaragam
pushed a commit
to nevinaragam/zarf
that referenced
this pull request
May 20, 2025
Signed-off-by: Austin Abro <AustinAbro321@gmail.com> Signed-off-by: NevinAragam <nevin.aragam@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Lint was using src/pkg/packager which will be replaced by packager2.
This comes with behavior changes in Lint that must be made to delete
src/pkg/packagerwithout greatly increasing complexity or duplicating lots of code.zarf package createdid not have schema checks so packages could have invalid schemas as still be used. Now that a package with an invalid schema will always fail create, earlier validation makes sense.For example, before this PR a warning looks like this:
After this PR they look like this:
Checklist before merging