fix(cmd-api-server): deprecate cockpitWwwRoot default path (cactus-cockpit removed)#4146
Open
sputnik-mac wants to merge 2 commits intohyperledger-cacti:mainfrom
Open
Conversation
sputnik-mac
requested review from
AndreAugusto11,
LordKubaya,
RafaelAPB,
VRamakrishna,
outSH and
sandeepnRES
as code owners
Contributor
|
@sputnik-mac Thank you for your contribution. Please sign your commits. |
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
2 participants
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.
Summary
Fixes #4108
The
@hyperledger/cactus-cockpitpackage has been removed from this monorepo, but the default value ofcockpitWwwRootinconfig-service.tsstill pointed to its (now non-existent) installation path:This path will never resolve, making the default misleading and potentially confusing.
Changes
packages/cactus-cmd-api-server/src/main/typescript/config/config-service.tsdefaultvalue ofcockpitWwwRootfrom the broken@hyperledger/cactus-cockpitpath to""(empty string)docstring to note that@hyperledger/cactus-cockpithas been removed and this option is deprecated; users who need a custom cockpit UI should supply a valid path viaCOCKPIT_WWW_ROOTor--cockpit-www-rootexamples/cactus-example-carbon-accounting-backend/example-config.jsoncockpitWwwRootfrom the stale package path to""to match the new default and avoid misleading anyone who copies this example configNotes
cockpitEnabledalready defaults tofalse, so there is no runtime regression — the cockpit file server will not start unless explicitly enabled.