Skip to end of banner
Go to start of banner

Application Creation and Maintenance

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

WORK IN PROGRESS

Creation of an application descriptor

  1. Create a dedicated repo, e.g. https://github.com/folio-org/app-consortia

    1. this can live in your github organization.  I don't think there's requirement that application descriptor repositories live in the "folio-org" github organization.

  2. Add an application descriptor template

    1. The mainline/master branch should use the "latest" version placeholder.  This gets replaced at "build" time with the latest snapshot version of the module.  See https://github.com/folio-org/app-consortia/blob/master/app-consortia.template.json for example.

    2. Declare application dependencies.     

    3. This tool can be helpful for generating the application descriptor, though in some cases it may be overkill https://github.com/folio-org/application-builder.  ATM it does not allow for module descriptor references (urls). It instead pulls in the entire module descriptors, but it does do dependency checking for you.

  3. Add a README - Again use existing application descriptor repositories for examples.

  4. Add a pom.xml - I would suggest copy/paste/modifying an existing one.  

Once you have that all set, you can clone your repo into a fresh place and try to "build" it (e.g. with mvn).  You should get an application descriptor which has the latest snapshot versions of modules.

Maintenance and Releases

This repository can now be tagged/released like any other repository, following standard release processes.

For releases, the “latest” placeholder should be replaced with an explicit module version.  The application version should also be a non-snapshot version, e.g. 1.0.0

Whenever a new version of the application’s modules are released, a new version of the application should also be released.

 

  • No labels