Merge pull request #46 from Catenscia/develop

Develop

.github/workflows/auto-bump.yaml

@@ -43,4 +43,9 @@ jobs:
       
       - name : Update changelog if targeting main branch
         if: ${{ github.event.pull_request.base.ref == 'main' }}
-        run: bash scripts/changelog_release.sh
+        run: |
+          bash scripts/changelog_release.sh
+          git add docs/source/dev_documentation/changelog.md
+          VERSION=$(bump2version --dry-run --list patch | grep current_version | sed -E 's/.*=//')
+          git commit -m "bump changelog: Unreleased -> ${VERSION}"
+          git push

.gitignore

@@ -2,6 +2,9 @@
 
 mxops_config.ini
 tutorials/**/contract
+logs
+testnet/*
+temp/*
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

CONTRIBUTING.md

@@ -11,15 +11,17 @@ If you encountered an issue or a bug, don't hesitate to write a detailed issue i
 ## Submitting changes
 
 If you fixed an issue or implemented a new feature, please send a pull request with a clear list of what you've done and make sure all of your commits are atomic
-(one feature per commit).
-Always write a clear log message for your commits.
+(one feature/action/change per commit).
+Please write clean commits messages by following the [conventional convention](https://www.conventionalcommits.org/en/v1.0.0/). The automated bump version workflow relies on this convention to opperate well.
 
-Please follow this steps:
+To submit your changes, follow this steps:
 
 - Fork this repo
-- create a new branch from `develop`
-- make your changes and commits continuously to your branch
-- execute `scripts/check_python_code.sh` and ensure that all tests pass
+- create a new branch from `develop` and call it `fix...`, `feature...`, `docs...` or else depending on your needs (see below)
+- make your changes and commits continuously to your local branch
+- If you have a changed or added a functionnality, make sure to add unit tests and/or integration tests to cover your change (don't hesitate to reach out if you need any help)
+- execute locally `bash scripts/check_python_code.sh` and ensure that all unit tests pass
+- execute locally `bash scripts/launch_integration_tests.sh <devnet/localnet>` and ensure that all integration tests pass (see [here for help](./integration_tests/README.md))
 - submit a PR from your branch to the `develop` branch of this repo
 
 ## Branch names
@@ -31,7 +33,7 @@ The examples below should fit most needs.
 |-------------------|--------------------------------------------------------|----------------------------|
 | **Feature**       | For any feature that will be added to the project      | `feature_<feature_name>`   |
 | **Fix**           | For any bug fix on the project                         | `fix_<bug_name>`           |
-| **Refactor**      | For any change that do not impact the functionalities | `refactor_<refactor_name>` |
+| **Refactor**      | For any change that do not impact the functionalities  | `refactor_<refactor_name>` |
 | **Test**          | For any test(s) that will be added to the project      | `test_<test_name>`         |
 | **Documentation** | For any change in the documentation                    | `docs_<change_name>`       |
 

README.md

@@ -1,7 +1,6 @@
 # MxOps
 
-MxOps is a python package created to automate MultiversX smart contracts deployments, calls and queries.
-Inspired from DevOps tools, it aims to ease and make reproducible any set of these interactions with smart-contracts.
+MxOps is a python package created to automate MultiversX transactions: be it smart contracts deployments, calls, queries or just simple transfers. Inspired from DevOps tools and built on top of [mxpy](https://github.com/multiversx/mx-sdk-py-cli), it aims to ease and make reproducible any set of these interactions with the blockchain.
 
 MxOps aims to be useful in these situations:
 
@@ -20,4 +19,4 @@ If you want this tool to improve, please tell us your issues and proposals!
 
 And if you're motivated, we will always welcome hepling hands onboard :grin: !
 
-Read the [contribution guidelines](./CONTRIBUTING.md) for more :wink:
+Read the [contribution guidelines](https://github.com/Catenscia/MxOps/blob/main/CONTRIBUTING.md) for more :wink:

docs/dictionary/custom_wordlist.txt

@@ -5,6 +5,7 @@ blockchains
 ChangeLog
 config
 configparser
+cli
 customization
 customizations
 DevOps

docs/dictionary/multiversx_wordlist.txt

@@ -4,6 +4,8 @@ devnet
 egld
 eGLD
 EgldOrEsdtTokenIdentifier
+Elrond
+elrond
 esdt
 ESDT
 ESDTmapper
@@ -13,10 +15,18 @@ localnet
 mainnet
 Maiar
 mandos
+multiversx
 MultiversX
 mxpy
+mx
+py
+NFT
+NFTs
 OptionalValue
 pem
+sc
+SFT
+SFTs
 testnet
 txs
 WEGLD

docs/dictionary/project_wordlist.txt

@@ -21,4 +21,6 @@ mxops
 PiggyBank
 PingAmount
 pylint
-runtime
+runtime
+SuccessCheck
+TransfersCheck

docs/source/dev_documentation/changelog.md

@@ -2,6 +2,27 @@
 
 ## Unreleased
 
+## 1.1.0 - 2023-05-11
+
+### Added
+
+- CLI options to clean/delete `Scenario` data before or after execution
+- `Steps` for token transfers  (eGLD, fungible & non fungible)
+- `Steps` for token issuance, roles management and minting (fungible & non fungible)
+- `TransfersCheck` to verify the transfers of a `ContractCallStep`
+- Networks enumerations can be parsed by their short or full names
+
+### Modified
+
+- Switch integration tests contracts from elrond-wasm to multiversx-sc
+- Add diverse precision on contribution
+
+### Fixed
+
+- Error when providing absolute path for `Scenes`
+- Commit change when auto bumping changelog version
+- Make the pylint test fail if a pylint error is detected
+
 ## 1.0.0 - 2023-03-09
 
 ### Added
@@ -21,25 +42,13 @@
 - Reorganize integration tests folders, scripts and scenario names
 - Convert the "Getting Started" section to a complete chapter in the documentation
 
-### Removed
-
-- None
-
 ## 0.1.1 - 2023-01-24
 
 ### Added
 
 - Readthedocs yaml configuration file to fix compilation
 - Full user tutorial in the sphinx documentation
 
-### Changed
-
-- None
-
-### Removed
-
-- None
-
 ## 0.1.0 - 2023-01-23
 
 First version of MxOps.