Release guide #820
Release guide #820
Conversation
|
The documentation is not available anymore as the PR was closed or merged. |
|
Following the guide to do a patch, I realize there's some info missing. Will complete once I'm done with the patch. |
There was a problem hiding this comment.
Thanks for the PR @LysandreJik . I think it'd be nice to move this to doc/dev/release.mdx rather than having it in setup.py.
setup.py
Outdated
| 4. Make sure that the conda build works correctly by building it locally: | ||
| ``` | ||
| conda install -c defaults anaconda-client conda-build | ||
| HUB_VERSION=<VERSION> conda-build .github/conda | ||
| ``` |
There was a problem hiding this comment.
do we want to maintain conda here? transformers doesn't seem to be uploading to our channel anymore, and we have our package on conda-forge. That recipe is more up-to-date.
There was a problem hiding this comment.
Right now the build works well and is automatic; I'd like to draft a small message to share with the rest of the team regarding conda support and whether we want to continue to support it through our own channel or not. In the meantime, I'd like to keep it here.
setup.py
Outdated
| 6. Commit, tag, and push the branch: | ||
| ``` | ||
| git commit -am "Release: v<VERSION>" | ||
| git tag v<VERSION> -m "Adds tag v<VERSION> for pypi and conda" | ||
| git push -u --tags origin v<MINOR-VERSION>-release | ||
| ``` |
There was a problem hiding this comment.
to give visibility to others, this can be a PR to the release branch instead of direct commit.
There was a problem hiding this comment.
It would also help with checking the doc build on that PR.
There was a problem hiding this comment.
How would you name the branch from which that PR is made? Others will get visibility with the release already, I am not 100% sure I see why the PR is necessary here
There was a problem hiding this comment.
that PR comes from the maintainer's own fork, doesn't matter how it's named. E.g: scikit-learn/scikit-learn#21120
In most cases it'll be a simple PR, but sometimes you might want to include more commits from the main branch.
setup.py
Outdated
| 8. Checkout main once again to update the version in the `__init__.py` file: | ||
| ``` | ||
| git checkout main | ||
| ``` |
Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
|
I'm having a hard time finding coherent names for the branches as I haven't followed that workflow previously; I'll merge this as it is, but very open if you want to open another PR to complete the existing doc with the two additional branches :) |
This PR adds a small release guide to the
setup.pyfor releases.I added it here as it's the same location as for the
transformerslibrary and it seems adequate, but happy to move it somewhere else more appropriate.