juju-solutions / layer-cwr

Layer for building the Juju Jenkins CI env
Other
2 stars 5 forks source link

Better documentation on workflows #79

Open bbcmicrocomputer opened 7 years ago

bbcmicrocomputer commented 7 years ago

I've looked at the documentation for cwr here:

https://jujucharms.com/u/juju-solutions/cwr-ci/ https://jujucharms.com/u/juju-solutions/cwr/

which is great :) .

I still feel like there could be better documentation around the Juju workflow actions, 'build-on-commit', 'build-bundle' etc. Specifically a numbered list (or similar) for the actions that will be performed.

For example:

  1. Check git repository for changes, if changes continue

For each controller:

a. Deploy charm and run tests b. Deploy reference bundle, run bundle tests c. Deploy individual charms from bundle (not target charm), run charm tests

I feel there's not enough explanation as to what is happening or the purpose of the workflow.