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