Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Foxcapades committed Jan 26, 2024
1 parent 6bde8dd commit 7f8381a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 12 deletions.
15 changes: 15 additions & 0 deletions readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,21 @@ DB_CONNECTION_DATA_SCHEMA_TOXO_DB=someSchema
----
====

== Publishing Server Updates

Once a change has been made to the VDI plugin handler server and is on the main
branch, the following steps must be taken to get the change out to the
individual plugins.

. Git tag the new version of the plugin server.
. Wait for Jenkins to build and publish the new server version's docker image.
. Update the Dockerfile in the https://github.com/VEuPathDB/vdi-docker-plugin-base[vdi-docker-plugin-base]
repository to pull from the new plugin server docker image version.
. Push the change and git tag the new plugin-base image.
. Wait for Jenkins to build and publish the new plugin-base docker image.
. Iterate through all the VDI plugin projects and update the Dockerfiles to pull
from the new plugin-base docker image version.

== Plugin Scripts

image::docs/assets/plugin-scripts-overall.svg[]
Expand Down
24 changes: 12 additions & 12 deletions service/src/main/kotlin/vdi/server/controller/install-data.kt
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@ suspend fun ApplicationCall.handleInstallDataRequest(appCtx: ApplicationContext)
// Run the install-data service and collect the returned list of
// installation warnings.
val warnings = InstallDataHandler(
workspace,
details.vdiID,
details.projectID,
payload,
dbDetails,
appCtx.executor,
appCtx.config.service.customPath,
appCtx.pathFactory.makePath(details.projectID, details.vdiID),
appCtx.config.service.installMetaScript,
appCtx.config.service.installDataScript,
appCtx.config.service.checkCompatScript,
appCtx.metrics.scriptMetrics,
workspace = workspace,
vdiID = details.vdiID,
projectID = details.projectID,
payload = payload,
dbDetails = dbDetails,
executor = appCtx.executor,
customPath = appCtx.config.service.customPath,
installPath = appCtx.pathFactory.makePath(details.projectID, details.vdiID),
metaScript = appCtx.config.service.installMetaScript,
dataScript = appCtx.config.service.installDataScript,
compatScript = appCtx.config.service.checkCompatScript,
metrics = appCtx.metrics.scriptMetrics,
)
.run()

Expand Down

0 comments on commit 7f8381a

Please sign in to comment.