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

configure v2: update library and usages #1

Merged
merged 1 commit into from
Jan 25, 2024
Merged

Conversation

M-Porter
Copy link
Owner

@M-Porter M-Porter commented Jan 25, 2024

Major version changes to the library.

  • Changes to how configs are setup: Instead of calling Setup() then Config() to create and get the config, you now just call Setup() providing a reference to your config as the second argument. This better matches the expectations of other functions like json.Unmarshal() and viper.Unmarshal().
  • The library no longer maintains an internal copy of the config. The implementer is now required to do so. This allows the library to be more simplistic and is a separation of concerns.
  • examples directory has been removed in favor of tests. Tests are the preferred way to show off example usage as they both confirm the library works as intended and shows that the examples are not out dated and do work.
  • go get -u github.com/m-porter/configure/v2 will refer to the main branch. Previous version code can be found under v1 branch.

@M-Porter M-Porter changed the title Update library and usages configure v2: update library and usages Jan 25, 2024
@M-Porter M-Porter added the enhancement New feature or request label Jan 25, 2024
@M-Porter M-Porter closed this Jan 25, 2024
@M-Porter M-Porter reopened this Jan 25, 2024
@M-Porter
Copy link
Owner Author

M-Porter commented Jan 25, 2024

Closed and reopened PR to trigger workflow

@M-Porter M-Porter merged commit e95542b into main Jan 25, 2024
4 checks passed
@M-Porter M-Porter deleted the v2-prep-configure-setup branch January 25, 2024 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant