[FOLIO-2237] Modify CI script which publishes minimal readme each back-end module to Docker Hub Created: 02/Sep/19  Updated: 02/Jun/21  Resolved: 09/Oct/19

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: P2
Reporter: David Crossley Assignee: David Crossley
Resolution: Done Votes: 0
Labels: devops, platform-backlog
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to FOLIO-3185 Improve Docker Hub README generator t... Open
relates to FOLIO-2008 Publish a minimal README at Docker Hu... Closed
relates to FOLIO-2541 Repair the CI script that generates a... Closed
relates to FOLIO-2321 Remove old ModuleDescriptor "metadata... Closed
relates to FOLIO-2185 SPIKE: how to maintain resource deplo... Closed
relates to FOLIO-2916 Modify CI job buildDocker to publish ... Closed
Sprint: CP: sprint 74, CP: sprint 73
Story Points: 3
Development Team: Core: Platform

 Description   

The purpose of this CI script is to automatically generate a minimal README for the Docker Hub of each back-end module. Provide some Docker-related information, and link back to the module's git README as the primary source of information.

The initial CI script utilises the basic ModuleDescriptor "metadata" section ( FOLIO-2008 Closed ).
See example generated readme for mod-login.

After the deployment of the new default LaunchDescriptor settings to all modules ( FOLIO-2234 Closed "core" and FOLIO-2235 Closed non-core") we can now modify this script to instead utilise the more detailed information extracted from the LaunchDescriptor (see documentation).

Expand the shell script at jenkins-pipeline-libs which uses 'jq' to extract relevant properties.



 Comments   
Comment by David Crossley [ 09/Oct/19 ]

Done. Now utilises information from the default launchDescriptor in the ModuleDescriptor, rather than its old "metadata" section.

See pull/69/ and pull/71/.

Comment by David Crossley [ 09/Oct/19 ]

Some examples:
https://hub.docker.com/r/folioci/mod-notes (has DB)
https://hub.docker.com/r/folioci/mod-codex-mux (no DB)
https://hub.docker.com/r/folioci/mod-source-record-storage (has extra environment)

Generated at Thu Feb 08 23:19:12 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.