[FOLIO-799] Post UI module descriptors to mod descriptor registry Created: 23/Aug/17  Updated: 12/Nov/18  Resolved: 21/Sep/17

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

Type: New Feature Priority: P2
Reporter: Wayne Schneider Assignee: John Malconian
Resolution: Done Votes: 0
Labels: ci, sprint21, sprint22, sprint23
Remaining Estimate: Not Specified
Time Spent: 3 hours
Original estimate: Not Specified

Issue links:
Blocks
blocks FOLIO-812 construct a vagrant image based on th... Closed
is blocked by FOLIO-629 Migrate existing Jenkins build jobs f... Closed
is blocked by STCOR-75 Update naming convention for Okapi mo... Closed
Relates
relates to FOLIO-629 Migrate existing Jenkins build jobs f... Closed
relates to FOLIO-728 publish ModuleDescriptors to the cent... Closed
Sprint:

 Description   

With the changes in Okapi to allow you to pull mod descriptors from a registry ( OKAPI-347 Closed ), and the coming ability to enable with dependencies ( OKAPI-349 Closed ), it probably makes sense to post the UI mod descriptors as well as the backend ones as part of the build process.



 Comments   
Comment by Wayne Schneider [ 31/Aug/17 ]

Conceptually, this is pretty straightforward:

After npm publish, do npm install @folio/stripes-core.
Run node node_modules/@folio/stripes-core/util/package2md.js --strict package.json > ModuleDescriptor.json
Post the module descriptor with curl or somesuch.

This would work for the existing Jenkins jobs, but we'll wait for John Malconian to complete refactoring the jobs using a shared Jenkins pipeline library ( FOLIO-629 Closed ).

There are currently no Jenkins jobs for releasing stripes modules, so there will need to be a different workflow to get those mod descriptors posted.

Comment by John Malconian [ 15/Sep/17 ]

Module Descriptors are posted for all UI modules except the ui-plugin-example modules. The new shared pipeline configuration doesn't take into account projects with multiple modules so I'll have to create an exception

Comment by John Malconian [ 15/Sep/17 ]

Wayne Schneider ui-plugin-example has the two pseudo modules - plugin-markdown-editor and plugin-markdown-better. These modules do absolutely nothing. Can we remove them from the FOLIO builds? There is already a legit UI plugin included in the build - plugin-find-user. Otherwise, I'd have to implement custom pipelines for the markdown plugin examples and its not worth the extra hassle. There should only be one module per project.

Comment by John Malconian [ 15/Sep/17 ]

Still TODO. Post mod descriptors for release builds.

Comment by Wayne Schneider [ 15/Sep/17 ]

Yes, we can remove the sample plugins from the build.

There is also a mod descriptor for stripes-core that we will need. stripes-core also has the trivial module. Should we remove that also? (it's only in the "testing" build, not the "stable" or "demo" builds)

Comment by John Malconian [ 15/Sep/17 ]

It's probably time to remove the trivial module.

Comment by John Malconian [ 15/Sep/17 ]

stripes-core has now been added to Pipelines and is posting mod descriptor for HEAD of master.

Comment by John Malconian [ 15/Sep/17 ]

I left out trivial module.

Comment by Mike Taylor [ 15/Sep/17 ]

I agree that one module per git repo is the right way of things. It was a stupid micro-optimisation on my part to put the two markdown-editor plugins in a single repo, and one that I have regretted on my own account even before John and Wayne complained.

In the short term, yes, just remove them from the build.

In the longer term, when we have real editors here, we'll put them in their own git repos. (The present ones exist only so we have a way to prove that the plugin framework functions.)

Comment by John Malconian [ 21/Sep/17 ]

complete.

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