Conversation
Address feedback from issue #529 regarding first-install experience and documentation generation errors when using includeAllModules = true. The README GitHub example was missing required options like domain, workersFile, and webhookSecretFile. Users had to examine test files to understand the workers.json format. This adds the missing options and documents the JSON format inline. Several options referenced config values in their defaults without providing defaultText, causing documentation generation to fail when modules were included but not fully configured. Add defaultText to webhookBaseUrl, worker.name, and all package options. Options like accessMode, cachix.auth, and the packages.* options lacked descriptions entirely, triggering warnings during documentation builds. The niks3.package option had a throwing default that caused evaluation errors even when niks3 was disabled. Remove the default entirely so users must explicitly set the package when enabling niks3. Enable warningsAreErrors in the test framework to catch similar issues in the future. Fixes: #529
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Address feedback from issue #529 regarding first-install experience and documentation generation errors when using includeAllModules = true.
The README GitHub example was missing required options like domain, workersFile, and webhookSecretFile. Users had to examine test files to understand the workers.json format. This adds the missing options and documents the JSON format inline.
Several options referenced config values in their defaults without providing defaultText, causing documentation generation to fail when modules were included but not fully configured. Add defaultText to webhookBaseUrl, worker.name, and all package options.
Options like accessMode, cachix.auth, and the packages.* options lacked descriptions entirely, triggering warnings during documentation builds.
The niks3.package option had a throwing default that caused evaluation errors even when niks3 was disabled. Remove the default entirely so users must explicitly set the package when enabling niks3.
Enable warningsAreErrors in the test framework to catch similar issues in the future.
Fixes: #529