|
2 | 2 | # How to release plotly packages
|
3 | 3 |
|
4 | 4 | There are 3 Python packages (`plotly`, `plotly-geo` and `chart-studio`) which need to be
|
5 |
| -published to PyPI and conda. In addition, there are various changelogs, github releases and forum announcements to do :) |
| 5 | +published to PyPI and conda. The `plotly` package is located in this repository, while `plotly-geo` and `chart-studio` are located in their own separate repositories under those names. |
| 6 | + |
| 7 | +In addition, there are various changelogs, github releases and forum announcements to do :) |
| 8 | + |
6 | 9 |
|
7 | 10 | ## Release process - `plotly` package and extensions
|
8 | 11 |
|
@@ -143,103 +146,3 @@ $ anaconda upload --label test plotly-*.tar.bz2
|
143 | 146 |
|
144 | 147 | The `--label test` part ensures that users won't install this version unless
|
145 | 148 | they explicitly ask for the version or for the version with the `next` tag.
|
146 |
| - |
147 |
| - |
148 |
| -## Release process - `plotly-geo` package |
149 |
| - |
150 |
| -The `plotly-geo` package contains the shape file resources used by plotly.py. |
151 |
| -These files are relatively large and change infrequently so it is useful |
152 |
| -to release them in a separate package. |
153 |
| - |
154 |
| -### Update version |
155 |
| - |
156 |
| -Update the version of the `plotly-geo` package in |
157 |
| -`packages/python/plotly-geo/setup.py`. |
158 |
| - |
159 |
| -This version is not intended to match the version of plotly.py. |
160 |
| - |
161 |
| -### Update CHANGELOG |
162 |
| - |
163 |
| -Add a new entry to the CHANGELOG at `packages/python/plotly-geo/CHANGELOG.md` |
164 |
| -and commit the changes. |
165 |
| - |
166 |
| -### Tag Release |
167 |
| - |
168 |
| -Create a new tag for the release |
169 |
| - |
170 |
| -```bash |
171 |
| -(plotly_dev) $ git checkout master |
172 |
| -(plotly_dev) $ git stash |
173 |
| -(plotly_dev) $ git pull origin master |
174 |
| -(plotly_dev) $ git tag plotly-geo-vX.Y.Z |
175 |
| -(plotly_dev) $ git push origin plotly-geo-vX.Y.Z |
176 |
| -``` |
177 |
| - |
178 |
| -### Publishing to PYPI |
179 |
| - |
180 |
| -Publish the final version to PyPI |
181 |
| - |
182 |
| -```bash |
183 |
| -(plotly_dev) $ cd packages/python/plotly-geo |
184 |
| -(plotly_dev) $ python setup.py sdist bdist_wheel |
185 |
| -(plotly_dev) $ twine upload dist/plotly-geo-X.Y.Z.tar.gz |
186 |
| -(plotly_dev) $ twine upload dist/plotly_geo-X.Y.Z-py3-none-any.whl |
187 |
| -``` |
188 |
| - |
189 |
| -### Publish to plotly anaconda channel |
190 |
| - |
191 |
| -From `packages/python/plotly-geo`, build the conda package |
192 |
| -```bash |
193 |
| -(plotly_dev) $ conda build recipe/ |
194 |
| -``` |
195 |
| - |
196 |
| -Then upload to the plotly anaconda channel as described above |
197 |
| - |
198 |
| -## Release process - `chart-studio` package |
199 |
| - |
200 |
| -The `chart-studio` package contains the utilities for interacting with |
201 |
| -Chart Studio (both Cloud or On-Prem). |
202 |
| - |
203 |
| -### Update version |
204 |
| - |
205 |
| -Update the version of the `chart-studio` package in |
206 |
| -`packages/python/chart-studio/setup.py`. |
207 |
| - |
208 |
| -This version is not intended to match the version of plotly.py. |
209 |
| - |
210 |
| -### Update CHANGELOG |
211 |
| - |
212 |
| -Add a new entry to the CHANGELOG at `packages/python/chart-studio/CHANGELOG.md` |
213 |
| -and commit the changes. |
214 |
| - |
215 |
| -### Tag Release |
216 |
| - |
217 |
| -Create a new tag for the release |
218 |
| - |
219 |
| -```bash |
220 |
| -(plotly_dev) $ git checkout master |
221 |
| -(plotly_dev) $ git stash |
222 |
| -(plotly_dev) $ git pull origin master |
223 |
| -(plotly_dev) $ git tag chart-studio-vX.Y.Z |
224 |
| -(plotly_dev) $ git push origin chart-studio-vX.Y.Z |
225 |
| -``` |
226 |
| - |
227 |
| -### Publishing to PYPI |
228 |
| - |
229 |
| -Publish the final version to PyPI |
230 |
| - |
231 |
| -```bash |
232 |
| -(plotly_dev) $ cd packages/python/chart-studio |
233 |
| -(plotly_dev) $ python setup.py sdist bdist_wheel |
234 |
| -(plotly_dev) $ twine upload dist/chart-studio-X.Y.Z.tar.gz |
235 |
| -(plotly_dev) $ twine upload dist/chart_studio-X.Y.Z-py3-none-any.whl |
236 |
| -``` |
237 |
| - |
238 |
| -### Publish to plotly anaconda channel |
239 |
| - |
240 |
| -From `packages/python/plotly-geo`, build the conda package |
241 |
| -```bash |
242 |
| -(plotly_dev) $ conda build recipe/ |
243 |
| -``` |
244 |
| - |
245 |
| -Then upload to the plotly anaconda channel as described above. |
0 commit comments