Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save rymurr/b7742e3fe3ba40931f425f96e9b97eba to your computer and use it in GitHub Desktop.
Save rymurr/b7742e3fe3ba40931f425f96e9b97eba to your computer and use it in GitHub Desktop.

Revisions

  1. @audreyfeldroy audreyfeldroy revised this gist Sep 18, 2015. 1 changed file with 15 additions and 39 deletions.
    54 changes: 15 additions & 39 deletions pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -1,60 +1,36 @@
    - [x] Update HISTORY.rst
    - [x] Update version number in `my_project/__init__.py`
    - [x] Update version number in `setup.py`
    - [x] Install the package again for local development, but with the new version number:
    - [ ] Update HISTORY.rst
    - [ ] Commit the changes:
    ```
    python setup.py develop
    git add HISTORY.rst
    git commit -m "Changelog for upcoming release 0.1.1."
    ```
    - [x] Run the tests:
    - [ ] Update version number (can also be minor or major)
    ```
    python setup.py test
    tox
    bumpversion patch
    ```

    - [x] Commit the changes:
    - [ ] Install the package again for local development, but with the new version number:
    ```
    git add .
    git commit -m "Release 0.1.1"
    ```

    - [x] Build the source distribution:
    ```
    python setup.py sdist
    python setup.py develop
    ```

    - [x] Test that the sdist installs:
    - [ ] Run the tests:
    ```
    mktmpenv
    cd dist
    tar xzvf my_project-0.1.1.tar.gz
    cd my_project-0.1.1/
    python setup.py install
    <try out my_project>
    deactivate
    tox
    ```

    - [x] Release on PyPI by uploading both sdist and wheel:
    - [ ] Release on PyPI by uploading both sdist and wheel:
    ```
    python setup.py sdist upload
    python setup.py bdist_wheel upload
    ```

    - [x] Test that it pip installs:
    - [ ] Test that it pip installs:
    ```
    mktmpenv
    pip install my_project
    <try out my_project>
    deactivate
    ```

    - [x] Tag the last git commit with the version number:
    ```
    git tag -a 0.1.1
    ```

    Put the same message as in HISTORY.rst.
    - [x] Push: `git push`
    - [x] Push tags: `git push --tags`
    - [x] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
    - [ ] Push: `git push`
    - [ ] Push tags: `git push --tags`
    - [ ] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
    - [ ] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.

  2. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -55,6 +55,6 @@ git tag -a 0.1.1
    Put the same message as in HISTORY.rst.
    - [x] Push: `git push`
    - [x] Push tags: `git push --tags`
    - [ ] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
    - [x] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
    - [ ] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.

  3. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -54,7 +54,7 @@ git tag -a 0.1.1

    Put the same message as in HISTORY.rst.
    - [x] Push: `git push`
    - [ ] Push tags: `git push --tags`
    - [x] Push tags: `git push --tags`
    - [ ] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
    - [ ] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.

  4. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -53,7 +53,7 @@ git tag -a 0.1.1
    ```

    Put the same message as in HISTORY.rst.
    - [ ] Push: `git push`
    - [x] Push: `git push`
    - [ ] Push tags: `git push --tags`
    - [ ] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
    - [ ] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.
  5. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -47,7 +47,7 @@ pip install my_project
    deactivate
    ```

    - [ ] Tag the last git commit with the version number:
    - [x] Tag the last git commit with the version number:
    ```
    git tag -a 0.1.1
    ```
  6. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -39,7 +39,7 @@ python setup.py sdist upload
    python setup.py bdist_wheel upload
    ```

    - [ ] Test that it pip installs:
    - [x] Test that it pip installs:
    ```
    mktmpenv
    pip install my_project
  7. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -33,7 +33,7 @@ python setup.py install
    deactivate
    ```

    - [ ] Release on PyPI by uploading both sdist and wheel:
    - [x] Release on PyPI by uploading both sdist and wheel:
    ```
    python setup.py sdist upload
    python setup.py bdist_wheel upload
  8. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -22,7 +22,7 @@ git commit -m "Release 0.1.1"
    python setup.py sdist
    ```

    - [ ] Test that the sdist installs:
    - [x] Test that the sdist installs:
    ```
    mktmpenv
    cd dist
  9. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -17,7 +17,7 @@ git add .
    git commit -m "Release 0.1.1"
    ```

    - [ ] Build the source distribution:
    - [x] Build the source distribution:
    ```
    python setup.py sdist
    ```
  10. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -11,7 +11,7 @@ python setup.py test
    tox
    ```

    - [ ] Commit the changes:
    - [x] Commit the changes:
    ```
    git add .
    git commit -m "Release 0.1.1"
  11. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -5,7 +5,7 @@
    ```
    python setup.py develop
    ```
    - [ ] Run the tests:
    - [x] Run the tests:
    ```
    python setup.py test
    tox
  12. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -1,7 +1,7 @@
    - [x] Update HISTORY.rst
    - [x] Update version number in `my_project/__init__.py`
    - [x] Update version number in `setup.py`
    - [ ] Install the package again for local development, but with the new version number:
    - [x] Install the package again for local development, but with the new version number:
    ```
    python setup.py develop
    ```
  13. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -1,6 +1,6 @@
    - [x] Update HISTORY.rst
    - [x] Update version number in `my_project/__init__.py`
    - [ ] Update version number in `setup.py`
    - [x] Update version number in `setup.py`
    - [ ] Install the package again for local development, but with the new version number:
    ```
    python setup.py develop
  14. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -1,5 +1,5 @@
    - [x] Update HISTORY.rst
    - [ ] Update version number in `my_project/__init__.py`
    - [x] Update version number in `my_project/__init__.py`
    - [ ] Update version number in `setup.py`
    - [ ] Install the package again for local development, but with the new version number:
    ```
  15. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -1,4 +1,4 @@
    - [ ] Update HISTORY.rst
    - [x] Update HISTORY.rst
    - [ ] Update version number in `my_project/__init__.py`
    - [ ] Update version number in `setup.py`
    - [ ] Install the package again for local development, but with the new version number:
  16. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -56,5 +56,5 @@ git tag -a 0.1.1
    - [ ] Push: `git push`
    - [ ] Push tags: `git push --tags`
    - [ ] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
    - [x] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.
    - [ ] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.

  17. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -55,6 +55,6 @@ git tag -a 0.1.1
    Put the same message as in HISTORY.rst.
    - [ ] Push: `git push`
    - [ ] Push tags: `git push --tags`
    - [x] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
    - [ ] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
    - [x] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.

  18. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -54,7 +54,7 @@ git tag -a 0.1.1

    Put the same message as in HISTORY.rst.
    - [ ] Push: `git push`
    - [x] Push tags: `git push --tags`
    - [ ] Push tags: `git push --tags`
    - [x] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
    - [x] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.

  19. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -53,7 +53,7 @@ git tag -a 0.1.1
    ```

    Put the same message as in HISTORY.rst.
    - [x] Push: `git push`
    - [ ] Push: `git push`
    - [x] Push tags: `git push --tags`
    - [x] Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly. If not, copy and paste the RestructuredText into http://rst.ninjs.org/ to find out what broke the formatting.
    - [x] Edit the release on GitHub (e.g. https://github.com/audreyr/cookiecutter/releases). Paste the release notes into the release's release page, and come up with a title for the release.
  20. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -47,7 +47,7 @@ pip install my_project
    deactivate
    ```

    - [x] Tag the last git commit with the version number:
    - [ ] Tag the last git commit with the version number:
    ```
    git tag -a 0.1.1
    ```
  21. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -39,7 +39,7 @@ python setup.py sdist upload
    python setup.py bdist_wheel upload
    ```

    - [x] Test that it pip installs:
    - [ ] Test that it pip installs:
    ```
    mktmpenv
    pip install my_project
  22. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -33,7 +33,7 @@ python setup.py install
    deactivate
    ```

    - [x] Release on PyPI by uploading both sdist and wheel:
    - [ ] Release on PyPI by uploading both sdist and wheel:
    ```
    python setup.py sdist upload
    python setup.py bdist_wheel upload
  23. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -22,7 +22,7 @@ git commit -m "Release 0.1.1"
    python setup.py sdist
    ```

    - [x] Test that the sdist installs:
    - [ ] Test that the sdist installs:
    ```
    mktmpenv
    cd dist
  24. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -17,7 +17,7 @@ git add .
    git commit -m "Release 0.1.1"
    ```

    - [x] Build the source distribution:
    - [ ] Build the source distribution:
    ```
    python setup.py sdist
    ```
  25. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -11,7 +11,7 @@ python setup.py test
    tox
    ```

    - [x] Commit the changes:
    - [ ] Commit the changes:
    ```
    git add .
    git commit -m "Release 0.1.1"
  26. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -5,7 +5,7 @@
    ```
    python setup.py develop
    ```
    - [x] Run the tests:
    - [ ] Run the tests:
    ```
    python setup.py test
    tox
  27. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -1,7 +1,7 @@
    - [ ] Update HISTORY.rst
    - [ ] Update version number in `my_project/__init__.py`
    - [ ] Update version number in `setup.py`
    - [x] Install the package again for local development, but with the new version number:
    - [ ] Install the package again for local development, but with the new version number:
    ```
    python setup.py develop
    ```
  28. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. No changes.
  29. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -1,6 +1,6 @@
    - [ ] Update HISTORY.rst
    - [ ] Update version number in `my_project/__init__.py`
    - [x] Update version number in `setup.py`
    - [ ] Update version number in `setup.py`
    - [x] Install the package again for local development, but with the new version number:
    ```
    python setup.py develop
  30. @audreyfeldroy audreyfeldroy revised this gist Aug 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion pypi-release-checklist.md
    Original file line number Diff line number Diff line change
    @@ -1,5 +1,5 @@
    - [ ] Update HISTORY.rst
    - [x] Update version number in `my_project/__init__.py`
    - [ ] Update version number in `my_project/__init__.py`
    - [x] Update version number in `setup.py`
    - [x] Install the package again for local development, but with the new version number:
    ```