Merge pull request #1636 from WadeBarnes/main

Add announcement section to README.md
hyperledger · Apr 17, 2023 · a6e3c6c · a6e3c6c
2 parents 14ced3d + 1f843f1
commit a6e3c6c
Show file tree

Hide file tree

Showing 9 changed files with 74 additions and 59 deletions.
diff --git a/.github/workflows/PR.yaml b/.github/workflows/PR.yaml
@@ -6,7 +6,7 @@ on:
       - "!plenum/__version__.json"
 
     branches:
-      - ubuntu-20.04-upgrade
+      - main
 
 jobs:
   workflow-setup:

diff --git a/.github/workflows/Push.yaml b/.github/workflows/Push.yaml
@@ -2,14 +2,13 @@ name: Indy Plenum - Push Workflow
 on:
   push:
     branches:
-      - ubuntu-20.04-upgrade
-      - rocksdbfix
+      - main
     paths:
       - '**.py'
       - '.github/**'
       - 'build-scripts/**'
-      - 'bump_version.sh'      
-            
+      - 'bump_version.sh'
+
 jobs:
   workflow-setup:
     name: Initialize Workflow
@@ -21,7 +20,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 +42,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 +52,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]

diff --git a/.github/workflows/README.md b/.github/workflows/README.md
@@ -1,10 +1,10 @@
 # GitHub Actions Workflows
 
-The  [PR](PR.yaml) workflow runs on Pull Requests to the ubuntu-20.04-upgrade branch, 
+The  [PR](PR.yaml) workflow runs on Pull Requests to the main branch,
 which only contain changes to python files. If no python file is affected it doesn't run.
-The same applies to the [Push](Push.yaml) workflow respectively for pushes. 
+The same applies to the [Push](Push.yaml) workflow respectively for pushes.
 
-The [tag](tag.yaml), [releasepr](releasepr.yaml) and [publishRelease](publishRelease.yaml) workflows are used for the new [Release Workflow](../../docs/source/diagrams/release-workflow.png). 
+The [tag](tag.yaml), [releasepr](releasepr.yaml) and [publishRelease](publishRelease.yaml) workflows are used for the new [Release Workflow](../../docs/source/diagrams/release-workflow.png).
 They use reuseable workflows from the [indy-shared-gha](https://github.com/hyperledger) repository and the following workflow in this folder.
 
 + [reuseable_test.yaml](reuseable_test.yaml)

diff --git a/.github/workflows/reuseable_test.yaml b/.github/workflows/reuseable_test.yaml
@@ -51,6 +51,7 @@ jobs:
 
       - name: Install dependencies from deb
         run: |
+          apt update
           aptStr=$(dpkg-deb -I indy-plenum_*.deb | grep -P "Depends: " | sed 's~Depends:~~g;s~(~~g;s~)~~g;s~>~~g;s~<~~g' | tr -d " \t\n\r" | tr "," "\n")
           apt install -y ./indy-plenum_*.deb $aptStr libindy
           ln -s /usr/lib/ursa/libursa.so /usr/lib/libursa.so
@@ -116,6 +117,7 @@ jobs:
 
       - name: Install dependencies from deb
         run: |
+          apt update
           aptStr=$(dpkg-deb -I indy-plenum_*.deb | grep -P "Depends: " | sed 's~Depends:~~g;s~(~~g;s~)~~g;s~>~~g;s~<~~g' | tr -d " \t\n\r" | tr "," "\n")
           apt install -y ./indy-plenum_*.deb $aptStr libindy
           ln -s /usr/lib/ursa/libursa.so /usr/lib/libursa.so

diff --git a/README.md b/README.md
@@ -1,19 +1,34 @@
 ![logo](indy-logo.png)
 
-[![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)
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/hyperledger/indy-plenum/tree/main)
 
 
-* [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)
+- [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)
 
-## Plenum Byzantine Fault Tolerant Protocol    
+## 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,10 +109,10 @@ 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) 
-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`.
+If you want to use Gitpod simply use this [link](https://gitpod.io/#https://github.com/hyperledger/indy-plenum/tree/main)
+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/main`.
 
-**Note**: Be aware that the config files for Gitpod and VSCode are currently only used in the `ubuntu-20.04-upgrade` branch!
+**Note**: Be aware that the config files for Gitpod and VSCode are currently only used in the `main` branch!
 
 Please have a look at [Dev Setup](https://github.com/hyperledger/indy-node/blob/master/docs/setup-dev.md) in indy-node repo.
 It contains common setup for both indy-plenum and indy-node.

diff --git a/build-scripts/ubuntu-2004/build-3rd-parties.sh b/build-scripts/ubuntu-2004/build-3rd-parties.sh
@@ -122,7 +122,7 @@ build_from_pypi python-dateutil
 build_from_pypi python-rocksdb
 build_from_pypi python-ursa 0.1.1
 build_from_pypi rlp 0.6.0
-build_from_pypi semver 
+build_from_pypi semver 2.13.0
 build_from_pypi sha3 
 build_from_pypi six 
 build_from_pypi sortedcontainers 1.5.7

diff --git a/dev-setup/ubuntu/ubuntu-2004/SetupVMTest.txt b/dev-setup/ubuntu/ubuntu-2004/SetupVMTest.txt
@@ -10,28 +10,28 @@
 
         sudo apt-get update && sudo apt-get install -y \
             git \
-            wget \ 
-            unzip \ 
-            python3-pip \ 
-            python3-venv \ 
-            libsodium23 \ 
-            iptables \ 
-            at \ 
-            supervisor \ 
-            python3-nacl \ 
-            rocksdb-tools \ 
-            librocksdb5.17 \ 
-            librocksdb-dev \ 
-            libsnappy-dev \ 
-            liblz4-dev \ 
-            libbz2-dev \ 
-            libssl1.0.0 \ 
-            libindy \ 
+            wget \
+            unzip \
+            python3-pip \
+            python3-venv \
+            libsodium23 \
+            iptables \
+            at \
+            supervisor \
+            python3-nacl \
+            rocksdb-tools \
+            librocksdb5.17 \
+            librocksdb-dev \
+            libsnappy-dev \
+            liblz4-dev \
+            libbz2-dev \
+            libssl1.0.0 \
+            libindy \
             ursa
 
         git clone https://github.com/hyperledger/indy-node.git
         git clone https://github.com/hyperledger/indy-plenum.git
-        # in both indy-node and indy-plenum checkout origin/ubuntu-20.04-upgrade 
+        # in both indy-node and indy-plenum checkout origin/main
         sudo cp /usr/lib/ursa/libursa.* /usr/lib/
         # Should be done in python env
         pip install -U \
@@ -88,7 +88,7 @@
             zipp==1.2.0
 
 ##IDE Setup
-    Pycharm: 
+    Pycharm:
         # Open indy-node
         # Open indy-plenum - Link
         # Create virtual env in project structure - python interpreter
@@ -98,8 +98,8 @@
 ## Base Dependencies Needed to test
 ### Library Dependencies:
     libindy                                	1.15.0-bionic
-    libindy-crypto                         	0.4.5 
+    libindy-crypto                         	0.4.5
     ursa                                   	0.3.2-2
 
-    
+
 
diff --git a/docs/source/ci-cd.md b/docs/source/ci-cd.md
@@ -1,4 +1,4 @@
 # Continuous Integration / Delivery
-The same process from [indy-node](https://github.com/hyperledger/indy-node/tree/ubuntu-20.04-upgrade) is used.
-It is described in detail in the indy-node repistories [ci-cd.md](https://github.com/hyperledger/indy-node/blob/ubuntu-20.04-upgrade/docs/source/ci-cd.md).
+The same process from [indy-node](https://github.com/hyperledger/indy-node/tree/main) is used.
+It is described in detail in the indy-node repistories [ci-cd.md](https://github.com/hyperledger/indy-node/blob/main/docs/source/ci-cd.md).
 It is possible to run the process for plenum independent from node.
diff --git a/setup.py b/setup.py
@@ -127,8 +127,7 @@ def run(self):
                         'python-ursa==0.1.1',
                         ### Tests fail without version pin (GHA run: https://github.com/udosson/indy-plenum/actions/runs/1078745445)
                         'rlp==0.6.0',
-                        # 'semver==2.13.0',
-                        'semver',
+                        'semver==2.13.0',
                         # 'sha3==0.2.1',
                         'sha3',
                         # 'six==1.15.0',