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

sampleconfig: Use embed with external files. #3185

Merged
merged 1 commit into from
Sep 19, 2023

Commits on Sep 18, 2023

  1. sampleconfig: Use embed with external files.

    This updates the sampleconfig package to make use of Go's embed
    functionality introduced in Go 1.16 which is acceptable since the
    containing module requires Go 1.19.
    
    Embedded files are preferable because they bring the benefits of both
    external files in the repository that are easier to work with for
    external tools and the ability to access their content programmatically
    without having to deal with the various issues typically brought about
    by programmatically accessing external files.
    
    Also, when this was last updated to change the exported variable for
    dcrd's sample config file over to a function (so it can't be mutated and
    the implementation details can be changed if needed), the case for
    dcrctl was missed.  Moreover, the existence of both configs makes the
    func name FileContents ambiguous.
    
    Unfortunately, those things can't be changed now without causing a major
    module version bump to the main dcrd module which we really want to
    avoid.
    
    So, in order to address those things without needing a major module
    version bump, this deprecates the FileContents func and
    DcrctlSampleConfig variable and introduces two new functions named Dcrd
    and Dcrctl that return the respective embedded sample configs.
    davecgh committed Sep 18, 2023
    Configuration menu
    Copy the full SHA
    a20782d View commit details
    Browse the repository at this point in the history