Skip to content

Commit 1e02eb3

Browse files
committed
Update release instructions
1 parent c8094ff commit 1e02eb3

File tree

1 file changed

+37
-10
lines changed

1 file changed

+37
-10
lines changed

docs/contributing.rst

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,9 @@ GitHub interface and make sure all tests are passing. In general pull requests t
9191
Releasing
9292
~~~~~~~~~
9393

94+
One time setup
95+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
96+
9497
Pandoc is required for transforming the markdown README to the proper
9598
format to render correctly on pypi.
9699

@@ -106,30 +109,54 @@ Or on OSX:
106109
107110
brew install pandoc
108111
109-
To release a new version:
112+
Final test before each release
113+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
114+
115+
Before releasing a new version, build and test the package that will be released:
116+
117+
.. code:: sh
118+
119+
git checkout master && git pull
120+
121+
make package
122+
123+
# in another shell, navigate to the virtualenv mentioned in output of ^
124+
125+
# load the virtualenv with the packaged trinity release
126+
source package-smoke-test/bin/activate
127+
128+
# smoke test the release
129+
trinity --ropsten
130+
131+
Push the release to github & pypi
132+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
133+
134+
After confirming that the release package looks okay, release a new version:
110135

111136
.. code:: sh
112137
113-
bumpversion $$VERSION_PART_TO_BUMP$$
114-
git push && git push --tags
115-
make release
138+
make release bump=$$VERSION_PART_TO_BUMP$$
139+
140+
# While trinity and py-evm are colocated,
141+
# manually change trinity & py-evm version in setup_trinity.py
142+
make release-trinity
116143
117-
How to bumpversion
118-
^^^^^^^^^^^^^^^^^^
144+
Which version part to bump
145+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
119146

120147
The version format for this repo is ``{major}.{minor}.{patch}`` for
121148
stable, and ``{major}.{minor}.{patch}-{stage}.{devnum}`` for unstable
122149
(``stage`` can be alpha or beta).
123150

124-
To issue the next version in line, use bumpversion and specify which
125-
part to bump, like ``bumpversion minor`` or ``bumpversion devnum``.
151+
During a release, specify which part to bump, like
152+
``make release bump=minor`` or ``make release bump=devnum``.
126153

127-
If you are in a beta version, ``bumpversion stage`` will switch to a
154+
If you are in a beta version, ``make release bump=stage`` will switch to a
128155
stable.
129156

130157
To issue an unstable version when the current version is stable, specify
131158
the new version explicitly, like
132-
``bumpversion --new-version 4.0.0-alpha.1 devnum``
159+
``make release bump="--new-version 4.0.0-alpha.1 devnum"``
133160

134161

135162
How to release docker images

0 commit comments

Comments
 (0)