Update release instructions #5364
Conversation
emilykl
force-pushed
the
release-instructions-cleanup
branch
from
7957bed to
10c3321
Compare
There was a problem hiding this comment.
I think we should maintain plotly.py and plotly.js to match what's shown in the repos. Was there something that prompted the change?
There was a problem hiding this comment.
What do you mean by "to match what's shown in the repos"?
I changed it because I think the capitals make it easier to read, but I could be convinced otherwise.
There was a problem hiding this comment.
I mean that we refer to the libraries as "plotly.xy" instead of "Plotly.xy" in the README for each repo. It's not a big deal, but I always try to use the proper name for an item. Like "GitHub" instead of "Github".
There was a problem hiding this comment.
Yeah fair enough, I guess we should keep lowercase unless/until we change the styling across the board.
RELEASE.md
Outdated
| - `git add -u` | ||
| - `git commit -m "version changes for vX.Y.Z"` | ||
| - `git push` |
There was a problem hiding this comment.
| - `git add -u` | |
| - `git commit -m "version changes for vX.Y.Z"` | |
| - `git push` | |
| ```sh | |
| git add -u | |
| git commit -m "version changes for vX.Y.Z" | |
| git push | |
| ``` |
RELEASE.md
Outdated
| - `git tag vX.Y.Z` | ||
| - `git push origin vX.Y.Z` |
There was a problem hiding this comment.
FYI, the closing ``` isn't showing up in the suggestion for some reason.
| - `git tag vX.Y.Z` | |
| - `git push origin vX.Y.Z` | |
| ```sh | |
| git tag vX.Y.Z | |
| git push origin vX.Y.Z |
|
|
||
| ### Publishing to PyPI | ||
|
|
||
| The final step is to publish the release to PyPI. **You will need special permissions from Plotly leadership to do this.**. |
There was a problem hiding this comment.
Could you add some context or add instructions for who to contact?
There was a problem hiding this comment.
This doc is public so I'm not sure it makes sense to put more info here, but feel free to suggest different wording if you have an idea.
There was a problem hiding this comment.
Ah! Good point. Ignore this one.
| * Post an announcement to the [Plotly Python forum](https://community.plotly.com/c/plotly-python/5), with links to the README installation instructions and to the CHANGELOG. | ||
| * Update the previous announcement to point to this one | ||
| * Update the Github Release entry and CHANGELOG entry to have the nice title and a link to the announcement | ||
| * Update the GitHub Release entry and CHANGELOG entry to have the nice title and a link to the announcement |
Clean up and improve release instructions.
These edits reflect the steps I followed for the most recent release (6.3.1).