hyperledger / indy-plenum

Plenum Byzantine Fault Tolerant Protocol
https://wiki.hyperledger.org/display/indy
Apache License 2.0
215 stars 370 forks source link

Update release documentation to reflect new GHA release workflows #1591

Closed WadeBarnes closed 2 years ago

WadeBarnes commented 2 years ago

The new release workflow is defined here; https://github.com/hyperledger/indy-plenum/pull/1590

The PR contains a workflow diagram, docs/source/diagrams/release-workflow.puml, and some summary documentation regarding the GHA workflows, .github/workflows/README.md, which reference the diagram.

The official release documentation for indy-plenum should be updated to reference and describe the new process in more detail.

The release document for indy-plenum/node (all, or the majority of it) is in the indy-node project here; https://github.com/hyperledger/indy-node/blob/master/docs/source/ci-cd.md. That said, there should be release documentation of the indy-plenum project itself to describe it's release process, or at least refer to the combined release process in indy-node, the former is preferable since releases of indy-plenum technically can be done independently of indy-node.