RELEASING.md

Releasing new versions of docklib

Requirements

• Local clone of this repository
• Twine (pip3 install twine)
• Account on test.pypi.org
• Account on pypi.org

Steps

1. Ensure the version in docklib/__init__.py has been updated.

2. Ensure the change log has been updated and reflects actual release date.

3. Merge development branch to main/master branch.

4. Run docklib unit tests and fix any errors:

    managed_python3 -m unittest -v tests.unit
   

5. Build a new distribution package:

    rm -fv dist/*
    python3 setup.py sdist bdist_wheel
   

6. Upload package to test.pypi.org:

    twine upload --repository-url https://test.pypi.org/legacy/ dist/*
   

7. View resulting project on test.pypi.org and make sure it looks good.

8. Install test docklib in MacAdmins Python on a test Mac:

    managed_python3 -m pip install --upgrade -i https://test.pypi.org/simple/ docklib
   

9. Perform tests - manual for now.

10. Upload package to pypi.org:

     twine upload dist/*
    

11. View resulting project on pypi.org and make sure it looks good.

12. Install production docklib in MacAdmins Python on a test Mac:

     managed_python3 -m pip install --upgrade docklib
    

13. Build new installer package using build_pkg.sh:

     ./build_pkg.sh
    

    By default the resulting package is unsigned. To sign the package, provide the name of the signing certificate from your macOS keychain.

     ./build_pkg.sh "Developer ID Installer: John Doe (ABCDE12345)"
    

14. Create new release on GitHub. Add notes from change log. Attach built installer package.

15. Announce to dock-management and other relevant channels, if desired.