Skip to content

Commit

Permalink
removes -dev suffix from indy-plenum
Browse files Browse the repository at this point in the history
Signed-off-by: Andrey Kononykhin <[email protected]>
  • Loading branch information
andkononykhin committed Mar 24, 2019
1 parent 1efe14d commit e5a90d3
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ and [indy-node-docs](docs/source/).
## Indy Node Repository Structure

Indy Node repo consists of the following parts:
- indy-node:
- indy-node:
- [indy-plenum](https://github.com/hyperledger/indy-plenum)-based implementation of distributed ledger
- Extends plenum's base pool functionality with specific transactions support (CLAIM_DEF, SCHEMA, POOL_UPGRADE, etc.)
- indy-common
Expand All @@ -63,14 +63,14 @@ Indy Node repo consists of the following parts:
- The heart of the distributed ledger technology inside Hyperledger Indy.
- Most probably you will need to make changes in Plenum if you want to contribute to Indy.
So, if you want to work with Indy Node, you will need to have the Plenum code as well in most of the cases
and work with two projects at the same time
and work with two projects at the same time
(see [How to Start Working with the Code](#how-to-start-working-with-the-code) below).
- [indy-sdk](https://github.com/hyperledger/indy-sdk)
- An official SDK for Indy.
- it contains client and anoncreds implementation
- You don't need it to contribute to Indy-Node. But please use indy-sdk for your own applications dealing with Indy ecosystem.
- [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.

Expand All @@ -88,9 +88,9 @@ Use project name `INDY`.
- See [How to send a PR](#how-to-send-a-pr) below.


## How to Install a Test Network
## How to Install a Test Network

You can have a look at [Start Nodes](docs/source/start-nodes.md)
You can have a look at [Start Nodes](docs/source/start-nodes.md)
to understand what needs to be done to create a Network, initialize and start Nodes, and what scripts are provided for this.

The described process is automated in one of the ways below (it allow to install a test Network):
Expand Down Expand Up @@ -122,26 +122,26 @@ Please have a look at [Continuous integration/delivery](docs/source/ci-cd.md)
- Consider sending a design doc into `design` folder (as markdown or PlantUML diagram) for a new feature before implementing it
- Make sure that a new feature or fix is covered by tests (try following TDD)
- Make sure that documentation is updated according to your changes
- Provide a full description of changes in the PR including Jira ticket number if any
- Provide a full description of changes in the PR including Jira ticket number if any
- Make sure that all your commits have a DCO sign-off from the author
- Make sure that static code validation passed
- Make sure that static code validation passed
(you can run `flake8 .` on the project root to check it; you can install flake8 from pypi: `pip install flake8`)
- Put the link to the PR into `#indy-pr-review` channel in Rocket.Chat
- A reviewer needs to start your tests first (add `test this please` comment to the PR)
- You need to make sure that all the tests pass
- A reviewer needs to review the code and approve the PR. If there are review comments, they will be put into the PR itself.
- You must process them (feel free to reply in the PR threads, or have a discussion in Rocket.Chat if needed)
- A reviewer or maintainer will merge the PR (we usually use Squash)


#### How to send a PR to both plenum and node
If you made changes in both indy-plenum and indy-node, you need to do the following:
- Raise a PR to indy-plenum's master and wait until code is reviewed and merged (see above)
- So, a new build of indy-plenum is created
- Note a just built version of indy-plenum (indy-plenum-dev in pypi): X.Y.Z (you can check it either on [tags/releases](https://github.com/hyperledger/indy-plenum/releases) page, [pypi](https://pypi.python.org/pypi/indy-plenum-dev) or on CI server).
- Change indy-plenum-dev's dependency version to the new one in indy-node's [setup.py](https://github.com/hyperledger/indy-node/blob/master/setup.py).
- Note a just built version `X.Y.Z.devB` of indy-plenum (you can check it in [pypi](https://pypi.python.org/pypi/indy-plenum) or on CI server).
- Change indy-plenum's dependency version to the new one in indy-node's [setup.py](https://github.com/hyperledger/indy-node/blob/master/setup.py).
- Raise PR to indy-node's master and wait until code is reviewed and merged (see above)
- So, a new build of indy-node is created
- So, a new build of indy-node is created


## Docs and links
Expand Down
2 changes: 1 addition & 1 deletion dev-setup/ubuntu/init-dev-project.sh
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ echo "Installed indy-node..."

echo "Installing indy-plenum..."
pushd indy-plenum
pip uninstall -y indy-plenum-dev
pip uninstall -y indy-plenum
pip install -e .[tests]
popd
echo "Installed indy-plenum..."
Expand Down
2 changes: 1 addition & 1 deletion docs/source/ci-cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
What artifacts are produced after each push
- to `master` branch:
- indy-plenum:
- indy-plenum-dev in [pypi](https://pypi.python.org/pypi/indy-plenum-dev)
- indy-plenum in [pypi](https://pypi.python.org/pypi/indy-plenum)
- indy-plenum release tag (https://github.com/hyperledger/indy-plenum/releases)
- indy-node:
- indy-node-dev in [pypi](https://pypi.python.org/pypi/indy-node-dev)
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
data_files=[(
(BASE_DIR, ['data/nssm_original.exe'])
)],
install_requires=['indy-plenum-dev==1.6.735',
install_requires=['indy-plenum==1.7.0.dev0',
'python-dateutil',
'timeout-decorator==0.4.0',
'distro==1.3.0'],
Expand Down

0 comments on commit e5a90d3

Please sign in to comment.