Remove baseapp dependency on the version package #4250
Merged
Conversation
This file contains 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
The version package is meant to be a convenience utility that provides SDK consumers with a ready-to-use version command that produces app's versioning information from flags passed at compile time. It will not make sense anymore for the baseapp package to depend on the version package once gaia will have been migrated away from the SDK main repository as we neither want to make assumptions nor set expectations on downstream apps buildsystems. Thus BaseApp now provides SetAppVersion() and AppVersion() to to allow SDK consumers to set BaseApp's version information string once the struct is initialised.
Codecov Report
@@ Coverage Diff @@
## master #4250 +/- ##
==========================================
+ Coverage 58.91% 58.95% +0.04%
==========================================
Files 215 215
Lines 14482 14489 +7
==========================================
+ Hits 8532 8542 +10
+ Misses 5310 5307 -3
Partials 640 640 |
alessio
requested review from
alexanderbez,
jackzampolin and
rigelrozanski
as code owners
rigelrozanski
approved these changes
May 2, 2019
| Commit = "" | ||
| Version = "" | ||
| // Application's name | ||
| Name = "" |
There was a problem hiding this comment.
This PR should probably show an example for how the gaia Name is set here (within the cmd/gaia) - I'm assuming you just forgot this
There was a problem hiding this comment.
I'm assuming you just forgot this
All these variables are set via build flags. I didn't provide examples as there were any before.
There was a problem hiding this comment.
I've improved the version package docs
alexanderbez
reviewed
May 2, 2019
baseapp/baseapp.go
Outdated
| func (app *BaseApp) AppVersion() string { return app.appVersion } | ||
|
|
||
| // SetAppVersion sets the application's version string. | ||
| func (app *BaseApp) SetAppVersion(v string) { app.appVersion = v } |
There was a problem hiding this comment.
This should probably live in options.go and check for sealed?
fedekunze
suggested changes
May 2, 2019
There was a problem hiding this comment.
Agree with @alexanderbez comment that it should check if the version is sealed before setting it
baseapp/baseapp.go
Outdated
| func (app *BaseApp) AppVersion() string { return app.appVersion } | ||
|
|
||
| // SetAppVersion sets the application's version string. | ||
| func (app *BaseApp) SetAppVersion(v string) { app.appVersion = v } |
alessio
deleted the
alessio/gaia-split-prep-remove-baseapp-dep-on-version-pkg
branch
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.
The version package is meant to be a convenience utility
that provides SDK consumers with a ready-to-use version
command that produces app's versioning information from
flags passed at compile time.
It will not make sense anymore for the baseapp package
to depend on the version package once gaia will have been
migrated away from the SDK main repository as we neither
want to make assumptions nor set expectations on downstream
apps buildsystems. Thus BaseApp now provides SetAppVersion()
and AppVersion() to to allow SDK consumers to set BaseApp's
version information string once the struct is initialised.
docs/)clog add [section] [stanza] [message]Files changedin the github PR explorerFor Admin Use: