Add announcement section to README.md

- Inform people of the change to the branch structure.

Signed-off-by: Wade Barnes <wade@neoterictech.ca>

.github/workflows/PR.yaml

@@ -6,7 +6,7 @@ on:
       - "!plenum/__version__.json"
 
     branches:
-      - ubuntu-20.04-upgrade
+      - main
 
 jobs:
   workflow-setup:

.github/workflows/Push.yaml

@@ -2,14 +2,14 @@ name: Indy Plenum - Push Workflow
 on:
   push:
     branches:
-      - ubuntu-20.04-upgrade
+      - main
       - rocksdbfix
     paths:
       - '**.py'
       - '.github/**'
       - 'build-scripts/**'
-      - 'bump_version.sh'      
-            
+      - 'bump_version.sh'
+
 jobs:
   workflow-setup:
     name: Initialize Workflow
@@ -21,7 +21,7 @@ jobs:
       # to all subsequent jobs that reference image repositories
       # as the push and pull operations require the URL of the repository
       # to be in lowercase.
-      GITHUB_REPOSITORY_NAME: ${{ steps.setup.outputs.GITHUB_REPOSITORY_NAME }} 
+      GITHUB_REPOSITORY_NAME: ${{ steps.setup.outputs.GITHUB_REPOSITORY_NAME }}
       distribution: ${{ steps.setup.outputs.distribution }}
       publish: ${{ steps.setup.outputs.publish }}
     steps:
@@ -43,7 +43,7 @@ jobs:
       CACHE_KEY_BUILD: ${{ needs.workflow-setup.outputs.CACHE_KEY_BUILD }}
       DOCKER_IMAGE: ghcr.io/${{ needs.workflow-setup.outputs.GITHUB_REPOSITORY_NAME }}/plenum-build
       UBUNTU_VERSION: ${{ needs.workflow-setup.outputs.UBUNTU_VERSION }}
-    
+
   build_packages:
     name: Build Packages
     needs: [workflow-setup, build-docker-image]
@@ -53,8 +53,8 @@ jobs:
       UBUNTU_VERSION: ${{ needs.workflow-setup.outputs.UBUNTU_VERSION }}
       isDev: 'true'
       isRC: 'false'
-      moduleName: plenum      
-  
+      moduleName: plenum
+
   plenum_tests:
     name: Test Plenum
     needs: [workflow-setup, lint, build_packages]

README.md

@@ -3,17 +3,32 @@
 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/hyperledger/indy-plenum/tree/ubuntu-20.04-upgrade)
 
 
-* [Plenum Byzantine Fault Tolerant Protocol](#plenum-byzantine-fault-tolerant-protocol)
-* [Technical Overview of Indy Plenum](#technical-overview-of-indy-plenum)
-* [Other Documentation](#other-documentation)
-* [Indy Plenum Repository Structure](#indy-plenum-repository-structure)
-* [Dependencies](#dependencies)
-* [Contact Us](#contact-us)
-* [How to Contribute](#how-to-contribute)
-* [How to Start Working with the Code](#how-to-start-working-with-the-code)
-* [Try Plenum Locally](#try-plenum-locally)
-
-## Plenum Byzantine Fault Tolerant Protocol    
+- [Announcements](#announcements)
+  - [April 12 2023](#april-12-2023)
+- [Plenum Byzantine Fault Tolerant Protocol](#plenum-byzantine-fault-tolerant-protocol)
+- [Technical Overview of Indy Plenum](#technical-overview-of-indy-plenum)
+- [Other Documentation](#other-documentation)
+- [Indy Plenum Repository Structure](#indy-plenum-repository-structure)
+- [Dependencies](#dependencies)
+- [Contact Us](#contact-us)
+- [How to Contribute](#how-to-contribute)
+- [How to Start Working with the Code](#how-to-start-working-with-the-code)
+
+## Announcements
+
+### April 12 2023
+
+**_The project branches have changed._**
+
+The `main` branch now contains the Ubuntu 20.04 work stream, and the previous `main` branch containing the Ubuntu 16.04 work stream has been moved to the `ubuntu-16.04` branch.  We encourage everyone to switch to using the new code and appreciate your patience while we stabilize the work flows and documentation on this new branch.
+
+The following changes were made to the branches:
+- `main` (default) renamed to `ubuntu-16.04`
+  - This retargeted the associated PRs.
+- `ubuntu-20.04-upgrade` set as the default branch.
+- `ubuntu-20.04-upgrade` (default) renamed to `main`
+
+## Plenum Byzantine Fault Tolerant Protocol
 
 Plenum is the heart of the distributed ledger technology inside Hyperledger
 Indy. As such, it provides features somewhat similar in scope to those
@@ -22,7 +37,7 @@ system, whereas Fabric is general purpose.
 
 ## Technical Overview of Indy Plenum
 
-Refer to our documentation site at [indy.readthedocs.io](https://hyperledger-indy.readthedocs.io/projects/plenum/en/latest/index.html) for the most current documentation and walkthroughs. 
+Refer to our documentation site at [indy.readthedocs.io](https://hyperledger-indy.readthedocs.io/projects/plenum/en/latest/index.html) for the most current documentation and walkthroughs.
 
 Please find the general overview of the system in [Overview of the system](docs/source/main.md).
 
@@ -32,7 +47,7 @@ More documentation can be found in [docs](docs).
 
 ## Other Documentation
 
-- Please have a look at aggregated documentation at [indy-node-documentation](https://github.com/hyperledger/indy-node/blob/master/README.md) which describes workflows and setup scripts common for both projects. 
+- Please have a look at aggregated documentation at [indy-node-documentation](https://github.com/hyperledger/indy-node/blob/master/README.md) which describes workflows and setup scripts common for both projects.
 
 
 ## Indy Plenum Repository Structure
@@ -42,9 +57,9 @@ More documentation can be found in [docs](docs).
 - common:
     - common and utility code
 - crypto:
-    - basic crypto-related code (in particular, [indy-crypto](https://github.com/hyperledger/indy-crypto) wrappers) 
+    - basic crypto-related code (in particular, [indy-crypto](https://github.com/hyperledger/indy-crypto) wrappers)
 - ledger:
-    - Provides a simple, python-based, immutable, ordered log of transactions 
+    - Provides a simple, python-based, immutable, ordered log of transactions
 backed by a merkle tree.
     - This is an efficient way to generate verifiable proofs of presence
 and data consistency.
@@ -63,12 +78,12 @@ mechanism that Plenum needs.
 ## Dependencies
 
 - Plenum makes extensive use of coroutines and the async/await keywords in
-Python, and as such, requires Python version 3.5.0 or later. 
+Python, and as such, requires Python version 3.5.0 or later.
 - Plenum also depends on [libsodium](https://download.libsodium.org/doc/), an awesome crypto library. These need to be installed
-separately. 
+separately.
 - Plenum uses [ZeroMQ](http://zeromq.org/) as a secure transport
 - [indy-crypto](https://github.com/hyperledger/indy-crypto)
-    - A shared crypto library 
+    - A shared crypto library
     - It's based on [AMCL](https://github.com/milagro-crypto/amcl)
     - In particular, it contains BLS multi-signature crypto needed for state proofs support in Indy.
 
@@ -94,7 +109,7 @@ If you are new to the concept of devcontainers in combination with VSCode [here]
 Simply clone this repository and VSCode will most likely ask you to open it in the devcontainer, if you have the correct extension("ms-vscode-remote.remote-containers") installed.
 If VSCode didn't ask to open it, open the command palette and use the `Remote-Containers: Rebuild and Reopen in Container` command.
 
-If you want to use Gitpod simply use this [link](https://gitpod.io/#https://github.com/hyperledger/indy-plenum/tree/ubuntu-20.04-upgrade) 
+If you want to use Gitpod simply use this [link](https://gitpod.io/#https://github.com/hyperledger/indy-plenum/tree/ubuntu-20.04-upgrade)
 or if you want to work with your fork, prefix the entire URL of your branch with  `gitpod.io/#` so that it looks like `https://gitpod.io/#https://github.com/hyperledger/indy-plenum/tree/ubuntu-20.04-upgrade`.
 
 **Note**: Be aware that the config files for Gitpod and VSCode are currently only used in the `ubuntu-20.04-upgrade` branch!