CCampJr/gist:711b7cc8c9faeb5ed6899ee71343a203

## gistfile1.md

      
    Raw
  

              gistfile1.md
            
          
    Simplified


git checkout dev
git pull --all
Change version number in init.py NEW VERSION
Change shields and badges in README and index.rst (docs) to point to master branch
git merge master
Commit changes (if needed)
git push
Wait for CI build to complete
git checkout master
git pull --all
git merge --no-ff dev
git tag -a NEW VERSION -m "Version NEW VERSION" (such as 0.1.0)
git push origin VERSION
Wait for CI build to complete
git push
Go to GH and do release from tag

$NEW_VERSION$ for example 0.2.1
$NEXT_VERSION$ for example 0.2.2
With GHActions


git checkout $NEW_VERSION
git pull --all
Change version number in init.py $NEW_VERSION
Change shields and badges in README and index.rst (docs) to point to master branch
git merge master
Commit changes (if needed)
git push
Wait for CI build to complete
git checkout master
git pull --all
git merge --no-ff $NEW_VERSION$ branch

git tag -a $NEW_VERSION$ -m "Version $NEW_VERSION$" (such as 0.1.0)
git push origin VERSION

Wait for CI build to complete
git push

Getting to Release Candidate


git checkout $NEW_VERSION
git pull --all
Change version number in init.py $NEW_VERSIONrc0

Change version in docs/conf.py if need be
Change shields and badges in README and index.rst (docs) to point to master branch
Clean out dist folder
Clean out docs (e.g. make clean)
Rebuild docs (sphinx-apidoc-run.sh)
Commit changes
Wait for CI build to complete
git merge master
Commit changes (if needed)
Wait for CI build to complete
python setup.py sdist
untar from dist folder into a new folder elsewhere
Check contents (NOTE if filenames have changed, sdist cache may use old name -- delete caches)
Within dist folder, python setup.py test (or just pytest.exe if the former fails to find pytest)
If all pass, delete folder and return to module directory
git tag -a $NEW_VERSION$rc0 -m "Test deployment for version $NEW_VERSION$rc0" (such as 0.1.0rc0)
git push origin VERSIONa0

Wait for CI build to complete
twine upload -r testpypi dist/FILEWITHCORRECTVERSION (it will ask for login info)

From RC to Master


Change version number in init.py $NEW_VERSION$

Change version in docs/conf.py if need be
Clean out dist folder
Clean out docs (e.g. make clean)
Rebuild docs (sphinx-apidoc-run.sh)
CHANGELOG Add Date and info to current release
CHANGELOG Next version blank header
Commit changes
git push
Wait for CI build to complete
python setup.py sdist
git tag -a $NEW_VERSION$ -m "Version $NEW_VERSION$"
git push origin $NEW_VERSION$

On GitHub, Add Version $NEW_VERSION$ to title of release and hit Publish
Wait for CI build to complete
twine upload dist/FILEWITHCORRECTVERSION (it will ask for login info)
git checkout master
git pull --all
git merge --no-ff $NEW_VERSION$ branch

git push

Setting Next Branch


git checkout $NEXT_VERSION$ branch
Change version number in init.py $NEXT_VERSIONa0

Change version in docs/conf.py if need be
Change shields and badges in README and index.rst (docs) to point to NEXT_VERSION branch