Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Publish a minimal README at Docker Hub for each back-end module

Description

Gather the relevant pieces of information. Some can be extracted from its Dockerfile, some from its ModuleDescriptor and its launchDescriptor, some from its GitHub repository properties.

Keep this minimal, and refer back to the module's README. We want the module's git README to be the primary source of information.

Consider also automatically appending part of this, as a summary section of the module's README in git.

Add a CI task to do this as part of the build pipelines.

Environment

None

Potential Workaround

None

Checklist

hide

TestRail: Results

Activity

Show:

mark.stacy June 7, 2019 at 8:26 PM
Edited

Added PR to Repo. Completed

John Malconian May 29, 2019 at 5:56 PM

Hmm. Good to know! I added the FOLIO jenkins account to the 'owners' team for the folioci repos, but not the folioorg repos. Let's try it and see how it works out.

mark.stacy May 29, 2019 at 5:19 PM

Creating the Repository within Docker Hub will have to be done by a user that is in the owners' team. No other way around this using Docker Hub. One of the drawbacks to Docker Hub. So, not sure if you want to keep it the same manual process or move the Jenkins user into the owners' team? I understand the security risks with the pipeline having the ability to create/delete repositories. Let me know what you want to do. Actually, there is no work to be done if you move into the owners' team.

mark.stacy May 29, 2019 at 5:10 PM

Thanks for the information regarding the pipeline. I will take a look.

John Malconian May 29, 2019 at 4:04 PM

You'll want to wrap the shell script with the necessary Docker Hub credentials using the following example when you insert it into the pipeline:

The most appropriate pipeline script to add this to is 'jenkins-pipeline-libs/vars/buildJavaDocker.groovy' - probably within the following conditional on line 122:

FWIW, I think this shell script could pretty easily be re-written as a pipeline code, but I'll leave that decision up to you.

Done

Details

Assignee

Reporter

Labels

Priority

Story Points

Sprint

Development Team

Core: Platform

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs
Created May 10, 2019 at 4:28 AM
Updated December 16, 2020 at 6:31 AM
Resolved June 7, 2019 at 8:26 PM
Configure
TestRail: Cases
TestRail: Runs