Skip to content

Commit

Permalink
Add notes for maintainers (#366)
Browse files Browse the repository at this point in the history
  • Loading branch information
@droserasprout
droserasprout authored Jun 24, 2024
1 parent c5e57a2 commit 864c9fc
Show file tree
Hide file tree
Showing 7 changed files with 82 additions and 54 deletions.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# CONTRIBUTING

## Maintainer guide

### Adding support for a new protocol

1. Check out the `baking-bad/sandboxed-node` repo. There should be "Update Octez binaries to X.Y" PR created automatically by `octez_version.yml` GitHub Action. Make sure everything works and merge it.
2. When something is merged to the `master` branch, another pipeline `tag.yml` will be triggered. It tags the current commit with `vX.Y.Z` and force pushes it. **BUG**: This pipeline currently fails with 403 for some reason. You need to pull the `master` and execute `make release` to run the process manually.
3. Now back to the PyTezos. Update `pytezos.sandbox.node.DOCKER_IMAGE` constant to the new image.
4. Set `pytezos.sandbox.node.LATEST` constant to the current protocol hash.
5. Update `sandbox_params` and `protocol_params` using values from Tezos source code and TzKT-hosted node RPC respectively.
6. Run `make docs` with `NODE_RPC_URL` environment variable set to the private full node to update references.
7. Read Release Notes for the new protocol and make necessary changes to the code.
8. Check if `make all` is green and `pytezos sandbox` works. Optionally, `michelson-kernel run` to check if the Jupyter kernel is fine.

### Releasing a new version

1. Checkout to `aux/X.Y.Z` branch. Update the version number in `pyproject.toml`.
2. Run `make before_release` to perform the pre-release routine.
3. Update `CHANGELOG.md` following the existing format.
4. After merging the PR, tag `X.Y.Z` on `master` and push to the origin.
5. For *.0 releases make sure that notifications are sent to Telegram, Slack and, manually, Discord.
3 changes: 3 additions & 0 deletions Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,3 +128,6 @@ kernel-docs: ## Build docs for Michelson IPython kernel

rpc-docs: ## Build docs for Tezos node RPC
poetry run python scripts/fetch_rpc_docs.py

before_release: ## Prepare for a new release after updating version in pyproject.toml
make update all
73 changes: 38 additions & 35 deletions poetry.lock
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 7 additions & 7 deletions requirements.dev.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ docker==6.1.3 ; python_full_version >= "3.8.1" and python_version < "3.13"
docutils==0.20.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
entrypoints==0.4 ; python_full_version >= "3.8.1" and python_version < "3.13"
eth-hash==0.7.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
eth-typing==4.2.3 ; python_full_version >= "3.8.1" and python_version < "3.13"
eth-typing==4.3.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
eth-utils==4.1.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
exceptiongroup==1.2.1 ; python_full_version >= "3.8.1" and python_version < "3.11"
execnet==2.1.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
Expand All @@ -53,7 +53,7 @@ isoduration==20.11.0 ; python_full_version >= "3.8.1" and python_version < "3.13
isort==5.13.2 ; python_full_version >= "3.8.1" and python_version < "3.13"
jedi==0.19.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
jinja2==3.1.4 ; python_full_version >= "3.8.1" and python_version < "3.13"
jsonpointer==2.4 ; python_full_version >= "3.8.1" and python_version < "3.13"
jsonpointer==3.0.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
jsonschema-specifications==2023.12.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
jsonschema==4.22.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
jsonschema[format-nongpl]==4.22.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
Expand All @@ -78,7 +78,7 @@ netstruct==1.1.2 ; python_full_version >= "3.8.1" and python_version < "3.13"
notebook-shim==0.2.4 ; python_full_version >= "3.8.1" and python_version < "3.13"
notebook==6.5.7 ; python_full_version >= "3.8.1" and python_version < "3.13"
overrides==7.7.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
packaging==24.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
packaging==24.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
pandocfilters==1.5.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
parameterized==0.9.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
parso==0.8.4 ; python_full_version >= "3.8.1" and python_version < "3.13"
Expand All @@ -90,7 +90,7 @@ platformdirs==4.2.2 ; python_full_version >= "3.8.1" and python_version < "3.13"
pluggy==1.5.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
ply==3.11 ; python_full_version >= "3.8.1" and python_version < "3.13"
prometheus-client==0.20.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
prompt-toolkit==3.0.46 ; python_full_version >= "3.8.1" and python_version < "3.13"
prompt-toolkit==3.0.47 ; python_full_version >= "3.8.1" and python_version < "3.13"
psutil==5.9.8 ; python_full_version >= "3.8.1" and python_version < "3.13"
ptyprocess==0.7.0 ; python_full_version >= "3.8.1" and python_version < "3.13" and (os_name != "nt" or sys_platform != "win32")
pure-eval==0.2.2 ; python_full_version >= "3.8.1" and python_version < "3.13"
Expand Down Expand Up @@ -143,7 +143,7 @@ testcontainers==3.7.1 ; python_full_version >= "3.8.1" and python_version < "3.1
tinycss2==1.3.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
tomli==2.0.1 ; python_full_version >= "3.8.1" and python_full_version <= "3.11.0a6"
toolz==0.12.1 ; python_full_version >= "3.8.1" and python_version < "3.13" and (implementation_name == "pypy" or implementation_name == "cpython")
tornado==6.4 ; python_full_version >= "3.8.1" and python_version < "3.13"
tornado==6.4.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
tqdm==4.66.4 ; python_full_version >= "3.8.1" and python_version < "3.13"
traitlets==5.14.3 ; python_full_version >= "3.8.1" and python_version < "3.13"
types-python-dateutil==2.9.0.20240316 ; python_full_version >= "3.8.1" and python_version < "3.13"
Expand All @@ -152,11 +152,11 @@ types-requests==2.32.0.20240602 ; python_full_version >= "3.8.1" and python_vers
types-setuptools==70.0.0.20240524 ; python_full_version >= "3.8.1" and python_version < "3.13"
types-simplejson==3.19.0.20240310 ; python_full_version >= "3.8.1" and python_version < "3.13"
types-tabulate==0.9.0.20240106 ; python_full_version >= "3.8.1" and python_version < "3.13"
typing-extensions==4.12.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
typing-extensions==4.12.2 ; python_full_version >= "3.8.1" and python_version < "3.13"
uri-template==1.3.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
urllib3==2.2.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
wcwidth==0.2.13 ; python_full_version >= "3.8.1" and python_version < "3.13"
webcolors==1.13 ; python_full_version >= "3.8.1" and python_version < "3.13"
webcolors==24.6.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
webencodings==0.5.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
websocket-client==1.8.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
wrapt==1.16.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
Expand Down
6 changes: 3 additions & 3 deletions requirements.slim.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ cytoolz==0.12.3 ; python_full_version >= "3.8.1" and python_version < "3.13" and
deprecation==2.1.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
docker==6.1.3 ; python_full_version >= "3.8.1" and python_version < "3.13"
eth-hash==0.7.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
eth-typing==4.2.3 ; python_full_version >= "3.8.1" and python_version < "3.13"
eth-typing==4.3.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
eth-utils==4.1.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
exceptiongroup==1.2.1 ; python_full_version >= "3.8.1" and python_version < "3.11"
fastecdsa==2.3.2 ; python_full_version >= "3.8.1" and python_version < "3.13"
Expand All @@ -22,7 +22,7 @@ jsonschema-specifications==2023.12.1 ; python_full_version >= "3.8.1" and python
jsonschema==4.22.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
mnemonic==0.21 ; python_full_version >= "3.8.1" and python_version < "3.13"
netstruct==1.1.2 ; python_full_version >= "3.8.1" and python_version < "3.13"
packaging==24.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
packaging==24.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
pkgutil-resolve-name==1.3.10 ; python_full_version >= "3.8.1" and python_version < "3.9"
ply==3.11 ; python_full_version >= "3.8.1" and python_version < "3.13"
py-ecc==7.0.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
Expand All @@ -43,7 +43,7 @@ tabulate==0.9.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
testcontainers==3.7.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
toolz==0.12.1 ; python_full_version >= "3.8.1" and python_version < "3.13" and (implementation_name == "pypy" or implementation_name == "cpython")
tqdm==4.66.4 ; python_full_version >= "3.8.1" and python_version < "3.13"
typing-extensions==4.12.1 ; python_full_version >= "3.8.1" and python_version < "3.11"
typing-extensions==4.12.2 ; python_full_version >= "3.8.1" and python_version < "3.13"
urllib3==2.2.1 ; python_full_version >= "3.8.1" and python_version < "3.13"
websocket-client==1.8.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
wrapt==1.16.0 ; python_full_version >= "3.8.1" and python_version < "3.13"
Expand Down
Loading

0 comments on commit 864c9fc

Please sign in to comment.