Skip to content
This repository was archived by the owner on Mar 19, 2021. It is now read-only.

Commit 26bbecc

Browse files
ariddellariddell
ariddell
authored andcommitted
doc: release howto updates
1 parent 94d1fbf commit 26bbecc

File tree

1 file changed

+32
-23
lines changed

1 file changed

+32
-23
lines changed

doc/release-howto.rst

Lines changed: 32 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,35 +11,40 @@ All steps except those described in "Tag Release" should be performed on a
1111
server with a high-bandwidth connection to the Internet. About 1000MiB worth of
1212
data will be uploaded to PyPi.
1313

14-
Tag Release
15-
===========
16-
14+
Before Tagging Release
15+
======================
1716
- Update release notes, ``doc/whats_new.rst``.
1817
- Double check version number in ``pystan/__init__.py``
1918
- Update version in snippet in ``doc/getting_started.rst``, i.e., "wget ..."
2019
- Commit any changes you just made.
2120
- Double check that tests pass for this commit.
22-
- Fast-forward branch ``master`` to ``develop``.
23-
- Release documentation
2421

25-
- ``git rebase master readthedocs``
26-
- ``git push --force origin readthedocs``
22+
Tag Release
23+
===========
2724

25+
- Fast-forward branch ``master`` to ``develop``.
2826
- Tag and sign the release
2927

30-
- For example, ``git tag --sign v2.4.0.1``
28+
- For example, ``git tag -u C3542448245BEC68F43070E4CCB669D9761F0CAC --sign v2.4.0.1``
3129
- Push tag to github ``git push --tags``
3230

33-
Build source distribution
34-
=========================
31+
Update Documentation
32+
=====================
33+
34+
*readthedocs needs a single patch to work.*
35+
36+
- Release documentation
37+
38+
- ``git rebase master readthedocs``
39+
- ``git push --force origin readthedocs``
40+
41+
Build source distribution and wheels
42+
====================================
3543

3644
Assemble source distribution::
3745

3846
./build_dist.sh
3947

40-
Build Wheels
41-
============
42-
4348
Linux and OSX: in the ``pystan-wheels`` repo update the ``pystan`` submodule
4449
and bump the version in ``.travis.yml``. Push changes.
4550

@@ -49,9 +54,6 @@ wheels.
4954
When wheels have been created they will be automatically uploaded to a
5055
Rackspace storage bucket.
5156

52-
Download Wheels
53-
---------------
54-
5557
After the wheels have finished building, download them from the Rackspace
5658
storage bucket.
5759

@@ -75,8 +77,8 @@ Upload Source Distribution and Wheels to PyPI
7577

7678
- Upload source distribution and wheels::
7779

78-
twine upload --skip-existing dist/*.tar.gz dist/*.tar.gz.asc
79-
twine upload --skip-existing dist/*.whl dist/*.whl.asc
80+
python3 -m twine upload --skip-existing dist/*.tar.gz dist/*.tar.gz.asc
81+
python3 -m twine upload --skip-existing dist/*.whl dist/*.whl.asc
8082

8183
If ``twine`` prompts for a username and password abort the process with
8284
Control-C and enter your PyPI credentials in ``$HOME/.pypirc``. (For more
@@ -97,6 +99,14 @@ Update Source
9799
- Add placeholder for next release in ``doc/whats_new.rst``.
98100
- Commit changes and push ``develop``.
99101

102+
Update Conda-Forge
103+
------------------
104+
105+
Update the repository at https://github.com/conda-forge/pystan-feedstock
106+
107+
You will need the sha256 of the tarball. Calculate it by hand or find it at
108+
https://pypi.org/project/pystan/#files after uploading the tarball.
109+
100110
Update Stan Website
101111
-------------------
102112

@@ -108,19 +118,18 @@ number in the following file needs to be incremented::
108118
Make Release Announcement
109119
-------------------------
110120

111-
Post a message to the stan-users mailing list. The following is an example from
121+
Post a message to the Stan discourse forum. The following is an example from
112122
PyStan 2.14.0.0 (subject is "pystan 2.14.0.0 released on PyPI")::
113123

114-
PyStan 2.14.0.0 is now available on PyPI. You may upgrade with
124+
PyStan 2.17.0.0 is now available on PyPI. You may upgrade with
115125

116-
python -m pip install --upgrade pystan
126+
python3 -m pip install --upgrade pystan
117127

118128
A list of changes is available in the customary location:
119129

120130
http://pystan.readthedocs.io/en/latest/whats_new.html
121131

122-
123132
TODO
124133
====
125134

126-
- Automate this entire process.
135+
- Automate more of this process.

0 commit comments

Comments
 (0)