New flag --document-dependency-values #112
Conversation
armsnyder
force-pushed
the
umbrella-values
branch
from
668ba98
to
1a8de64
Compare
|
@norwoodj My team has been battle-testing this change in our medium-size Helm chart repositories over the past month and are following my fork for now. No rush getting this reviewed, but I thought you should know it works in production. |
|
My team has umbrella charts as well that would benefit from this change. Definitely interested in seeing this merged. |
|
Thats cool! I think about to ask @norwoodj to allow additional maintainers to help to improve this project. |
|
I apologize for my slowness, I have not been very good at keeping up with pull requests here. I will try to take a look soon. |
|
Thanks! I'll resolve conflicts on this today. |
Adds new CLI flag -u/--document-dependency-values. The flag is disabled by default, so it should not affect existing behavior. **This change also includes two drive-by bug fixes!** * Replace usages of `path.Join` with `filepath.Join` when joining directories, for better cross-platform support. * Fix a `FileSortOrder` sorting bug in `model.go` where it would not sort by line due to an incorrect `valuesTableRows[i].LineNumber < valuesTableRows[i].LineNumber` comparison operation.
When evaluating chart dependencies, log a warning instead of aborting dependency resolution, if a dependency does not exist because it was invalid. This is useful for library charts which may not have values.
…ed in the root docs
armsnyder
force-pushed
the
umbrella-values
branch
from
1ae5163
to
fa4d751
Compare
|
@norwoodj I rebased my branch. I saw that the |
|
Merged. Thanks a ton for the contribution and sorry again for being so slow to review it. |
Features
Adds new CLI flag
-u/--document-dependency-valuesfor documenting values from dependencies, recursively.The flag is disabled by default, so it should not affect existing behavior.
Relates to #70 ; however it only supports local dependencies for now since it relies on the existing parsing logic.
Bug fixes
This change also includes two drive-by bug fixes.
path.Joinwithfilepath.Joinwhen joining directories, for better cross-platform support.FileSortOrdersorting bug inmodel.gowhere it would not sort by line due to an incorrectvaluesTableRows[i].LineNumber < valuesTableRows[i].LineNumbercomparison operation.Details
I added a new example chart called
umbrellaand ran the helm-docs command on it using--document-dependency-valuesto illustrate the change.In
main.go, instead of parsing and printing on the same pass, I changed it to parse first and print second. This let me reference values files from dependencies which were already parsed. Both passes use parallel processing, as before.