Skip to content

Commit

Permalink
Update setup.py
Browse files Browse the repository at this point in the history
  • Loading branch information
jeswan authored May 21, 2021
1 parent 76e1966 commit 310f22b
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
"""
Simple check list from huggingface/transformers repo: https://github.com/huggingface/transformers/blob/master/setup.py
To create the package for pypi.
Automatic Workflow Using GitHub Workflows (./.github/workflows/publish-to-test-pypi.yml)
1. Change the version in setup.py and docs (if applicable).
2. Create a new branch and commit these changes with the message: "Release: VERSION"
3. Open a pull request for the newly created branch
4. Closing the pull request will trigger this publishing script (publish-to-test-pypi.yml)
5. Add the release version to docs deployment (if applicable)
6. Update README.md to redirect to correct documentation.
Manual Instructions
1. Change the version in setup.py and docs (if applicable).
2. Unpin specific versions from setup.py.
2. Commit these changes with the message: "Release: VERSION"
3. Add a tag in git to mark the release: "git tag VERSION -m'Adds tag VERSION for pypi' "
Push the tag to git: git push --tags origin master
Expand All @@ -23,9 +32,8 @@
pip install -i https://testpypi.python.org/pypi jiant
6. Upload the final version to actual pypi:
twine upload dist/* -r pypi
7. Copy the release notes from RELEASE.md to the tag in github once everything is looking hunky-dory.
8. Add the release version to docs deployment (if applicable)
9. Update README.md to redirect to correct documentation.
7. Add the release version to docs deployment (if applicable)
8. Update README.md to redirect to correct documentation.
"""

import shutil
Expand Down

0 comments on commit 310f22b

Please sign in to comment.