Merge pull request #1811 from WadeBarnes/main

Add announcement section to README.md
hyperledger · Apr 13, 2023 · a26aad7 · a26aad7
2 parents 512cb1f + 4559097
commit a26aad7
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 53 deletions.
diff --git a/.github/workflows/PR.yaml b/.github/workflows/PR.yaml
@@ -6,7 +6,8 @@ on:
       - "!indy_node/__version__.json"
 
     branches:
-      - ubuntu-20.04-upgrade
+      - main
+
   workflow_dispatch:
 
 jobs:

diff --git a/.github/workflows/Push.yaml b/.github/workflows/Push.yaml
@@ -2,15 +2,14 @@ name: Indy Node - Push Workflow
 on:
   push:
     branches:
-      - ubuntu-20.04-upgrade
+      - main
       - test-automation-integration
-      - rocksdbfix
     paths:
       - '**.py'
       - '.github/**'
       - 'build-scripts/**'
       - 'bump_version.sh'
-      
+
 jobs:
   workflow-setup:
     name: Initialize Workflow
@@ -22,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:
@@ -35,7 +34,7 @@ jobs:
   lint:
     name: Lint
     uses: hyperledger/indy-shared-gha/.github/workflows/lint.yaml@v1
-      
+
   build-image:
     name: Create Builder Image
     needs: [workflow-setup, lint]

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/release-workflow.png). 
+The [tag](tag.yaml), [releasepr](releasepr.yaml) and [publishRelease](publishRelease.yaml) workflows are used for the new [Release Workflow](../../docs/release-workflow.png).
 They use reuseable workflows from the [indy-shared-gha](https://github.com/hyperledger/indy-shared-gha) repository and the following workflow in this folder.
 
 + [reuseable_test.yaml](reuseable_test.yaml)

diff --git a/README.md b/README.md
@@ -1,18 +1,40 @@
 ![logo](collateral/logos/indy-logo.png)
 
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/hyperledger/indy-node/tree/ubuntu-20.04-upgrade)
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/hyperledger/indy-node/tree/main)
 # Indy Node
-* [About Indy Node](#about-indy-node)
-* [Technical Overview of Indy Blockchain](#technical-overview-of-indy-blockchain)
-* [Indy Node Repository Structure](#indy-node-repository-structure)
-* [Dependent Projects](#dependent-projects)
-* [Contact us](#contact-us)
-* [How to Contribute](#how-to-contribute)
-* [How to Install a Test Network](#how-to-install-a-test-network)
-* [How to Start Working with the Code](#how-to-start-working-with-the-code)
-* [Continuous integration and delivery](https://github.com/hyperledger/indy-node/blob/master/docs/source/ci-cd.md)
-* [How to send a PR](#how-to-send-a-pr)
-* [Docs and links](#docs-and-links)
+- [Indy Node](#indy-node)
+  - [Announcements](#announcements)
+    - [April 12 2023](#april-12-2023)
+  - [About Indy Node](#about-indy-node)
+        - [Relationship with Sovrin](#relationship-with-sovrin)
+        - [Getting Started Guide](#getting-started-guide)
+        - [Hyperledger Wiki-Indy](#hyperledger-wiki-indy)
+  - [Technical Overview of Indy Blockchain](#technical-overview-of-indy-blockchain)
+  - [Indy Node Repository Structure](#indy-node-repository-structure)
+  - [Dependent Projects](#dependent-projects)
+  - [Contact us](#contact-us)
+  - [How to Contribute](#how-to-contribute)
+  - [How to Install a Test Network](#how-to-install-a-test-network)
+  - [How to Start Working with the Code](#how-to-start-working-with-the-code)
+  - [Continuous Integration and Delivery](#continuous-integration-and-delivery)
+  - [How to send a PR](#how-to-send-a-pr)
+      - [How to send a PR to both plenum and node](#how-to-send-a-pr-to-both-plenum-and-node)
+  - [Docs and links](#docs-and-links)
+
+
+## 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`
 
 ## About Indy Node
 
@@ -33,7 +55,7 @@ with a different network, using whatever conventions a community chooses.
 ##### Getting Started Guide
 
 We recommend that developers should explore
-[Indy Walk through](https://github.com/hyperledger/indy-sdk/blob/master/docs/getting-started/indy-walkthrough.md) to learn about Indy basics 
+[Indy Walk through](https://github.com/hyperledger/indy-sdk/blob/master/docs/getting-started/indy-walkthrough.md) to learn about Indy basics
 or [Getting Started Guide with VCX](https://github.com/hyperledger/indy-sdk/blob/master/vcx/docs/getting-started/getting-started.md) and
 [Getting Started Notebook](https://github.com/hyperledger/indy-sdk/blob/master/docs/getting-started/getting-started.ipynb).
 

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/setup-dev.md b/docs/source/setup-dev.md
@@ -6,10 +6,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-node/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-node/tree/ubuntu-20.04-upgrade`.
+If you want to use Gitpod simply use this [link](https://gitpod.io/#https://github.com/hyperledger/indy-node/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-node/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!
 
 
 There are also scripts that can help in setting up an environment and project for developers.
@@ -18,7 +18,7 @@ The scripts are in [dev-setup](https://github.com/hyperledger/indy-node/tree/mas
 
 **Note**: As of now, we provide scripts for Ubuntu only. It's not guaranteed that the code is working on Windows.
 
-- One needs Python 3.5 to work with the code 
+- One needs Python 3.5 to work with the code
 - We recommend using Python virtual environment for development
 - We use pytest for unit and integration testing
 - There are some dependencies that must be installed before being able to run the code
@@ -44,7 +44,7 @@ create a virtualenv to work in
     - Configure Project Interpreter to use just created virtualenv
         - Go to `Project: <name> -> Project Interpreter`
         - You’ll see indy-plenum and indy-node projects on the right side tab.
-        For each of them:   
+        For each of them:
             - Click on the project just beside “Project Interpreter” drop down, you’ll see one setting icon, click on it.
             - Select “Add Local”
             - Select existing virtualenv path as below: <virtual env path>/bin/python3.5
@@ -58,13 +58,13 @@ create a virtualenv to work in
         For each of them:
             - Select Py.test from the ‘Default test runner’
     - Press `Apply`
- 
+
 
 ## Detailed Setup
 
 ### Setup Python
 
-One needs Python 3.5 to work with the code. You can use `dev-setup/ubuntu/setup_dev_python.sh` script for quick installation of Python 3.5, pip 
+One needs Python 3.5 to work with the code. You can use `dev-setup/ubuntu/setup_dev_python.sh` script for quick installation of Python 3.5, pip
 and virtual environment on Ubuntu, or follow the detailed instructions below.
 
 
@@ -98,7 +98,7 @@ Download the latest build (pywin32-220.win-amd64-py3.5.exe is the latest build a
 
 Indy also depends on libsodium, an awesome crypto library. These need to be installed separately.
 
-##### Ubuntu 
+##### Ubuntu
 
 1. We need to install libsodium with the package manager. This typically requires a package repo that's not active by default. Inspect ```/etc/apt/sources.list``` file with your favorite editor (using sudo). On ubuntu 16, you are looking for a line that says ```deb http://us.archive.ubuntu.com/ubuntu xenial main universe```. On ubuntu 14, look for or add: ```deb http://ppa.launchpad.net/chris-lea/libsodium/ubuntu trusty main``` and ```deb-src http://ppa.launchpad.net/chris-lea/libsodium/ubuntu trusty main```.
 
@@ -170,7 +170,7 @@ on how Ursa can be installed and built for other platforms.
 We recommend creating a new Python virtual environment for trying out Indy.
 A virtual environment is a Python environment which is isolated from the
 system's default Python environment (you can change that) and any other
-virtual environment you create. 
+virtual environment you create.
 
 You can create a new virtual environment by:
 ```
@@ -209,7 +209,7 @@ Navigate to the root directory of the source (for each project) and install requ
 pip install -e .[tests]
 ```
 If you are working with both indy-plenum and indy-node, then please make sure that both projects are installed with -e option,
-and not from pypi (have a look at the sequence at `init-dev-project.sh`). 
+and not from pypi (have a look at the sequence at `init-dev-project.sh`).
 
 Go to the folder with tests (either `indy-plenum`, `indy-node/indy_node`, `indy-node/indy_client` or `indy-node/indy_common`)
 and run tests