GitHub-Proxy/pygcode
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/petaflot/pygcode synced 2025-08-12 17:29:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

added change-log update to deployment checklist

Browse Source
This commit is contained in:
Peter Boin 2017-08-15 22:00:13 +10:00
parent eb52cd0551
commit 710b968cd8
1 changed files with 107 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

160
deployment/README.md
View File

@ -9,21 +9,20 @@ this can help.
Method based on the articles: Method based on the articles:
* http://peterdowns.com/posts/first-time-with-pypi.html and * http://peterdowns.com/posts/first-time-with-pypi.html and
* https://hynek.me/articles/sharing-your-labor-of-love-pypi-quick-and-dirty/ * https://hynek.me/articles/sharing-your-labor-of-love-pypi-quick-and-dirty/
Deployment also heavily uses the `./deploy.sh` script in this folder. Deployment also heavily uses the `./deploy.sh` script in this folder.
At this time, running `./deploy.sh --help` displays: At this time, running `./deploy.sh --help` displays:
``` Usage: ./deploy.sh {build|test|and so on ...}
Usage: ./deploy.sh {build|test|and so on ...}
This script is to maintain a consistent method of deployment and testing. This script is to maintain a consistent method of deployment and testing.
Deployment target: pygcode 0.1.1.dev0 Deployment target: pygcode 0.1.1.dev0
Arguments: Arguments:
Setup: Setup:
setup: Installs packages & sets up environment (requires sudo) setup: Installs packages & sets up environment (requires sudo)
@ -56,7 +55,6 @@ Arguments:
py#: when referenced above means py#: when referenced above means
'py2' for Python 2.7.12 'py2' for Python 2.7.12
'py3' for Python 3.5.2 'py3' for Python 3.5.2
```
# PyPi deployment # PyPi deployment
@ -68,22 +66,20 @@ Arguments:
`cat ~/.pypirc` `cat ~/.pypirc`
``` [distutils]
[distutils] index-servers =
index-servers =
prod prod
test test
[prod] [prod]
repository = https://upload.pypi.org/legacy/ repository = https://upload.pypi.org/legacy/
username=FraggaMuffin username=FraggaMuffin
password=secret password=secret
[test] [test]
repository=https://test.pypi.org/legacy/ repository=https://test.pypi.org/legacy/
username=FraggaMuffin username=FraggaMuffin
password=secret password=secret
```
`chmod 600 ~/.pypirc` `chmod 600 ~/.pypirc`
@ -91,59 +87,56 @@ password=secret
## Build and Test `sdist` and `wheel` ## Build and Test `sdist` and `wheel`
**Build** **Build**
```
./deploy.sh build ./deploy.sh build
```
**Test `sdist`** **Test `sdist`**
```
# Python 2.x
./deploy.sh remkenv py2
./deploy.sh envprereq py2
./deploy.sh install sdist py2
./deploy.sh test installed py2
# Python 3.x # Python 2.x
./deploy.sh remkenv py3 ./deploy.sh remkenv py2
./deploy.sh envprereq py3 ./deploy.sh envprereq py2
./deploy.sh install sdist py3 ./deploy.sh install sdist py2
./deploy.sh test installed py3 ./deploy.sh test installed py2
```
# Python 3.x
./deploy.sh remkenv py3
./deploy.sh envprereq py3
./deploy.sh install sdist py3
./deploy.sh test installed py3
**Test `wheel`** **Test `wheel`**
```
# Python 2.x
./deploy.sh remkenv py2
./deploy.sh install wheel py2
./deploy.sh test installed py2
# Python 3.x # Python 2.x
./deploy.sh remkenv py3 ./deploy.sh remkenv py2
./deploy.sh install wheel py3 ./deploy.sh install wheel py2
./deploy.sh test installed py3 ./deploy.sh test installed py2
```
# Python 3.x
./deploy.sh remkenv py3
./deploy.sh install wheel py3
./deploy.sh test installed py3
## Upload to PyPi Test server ## Upload to PyPi Test server
```
./deploy.sh deploy test ./deploy.sh deploy test
```
**Test** **Test**
```
# Python 2.x
./deploy.sh remkenv py2
./deploy.sh envprereq py2
./deploy.sh install pypitest py2
./deploy.sh test installed py2
# Python 3.x # Python 2.x
./deploy.sh remkenv py3 ./deploy.sh remkenv py2
./deploy.sh envprereq py3 ./deploy.sh envprereq py2
./deploy.sh install pypitest py3 ./deploy.sh install pypitest py2
./deploy.sh test installed py3 ./deploy.sh test installed py2
```
# Python 3.x
./deploy.sh remkenv py3
./deploy.sh envprereq py3
./deploy.sh install pypitest py3
./deploy.sh test installed py3
have a look at: have a look at:
https://testpypi.python.org/pypi/pygcode https://testpypi.python.org/pypi/pygcode
@ -154,22 +147,19 @@ to make sure it's sane
all good!? sweet :+1: time to upload to 'production' all good!? sweet :+1: time to upload to 'production'
``` ./deploy.sh deploy prod
./deploy.sh deploy prod
```
**Test** **Test**
```
# Python 2.x
./deploy.sh remkenv py2
./deploy.sh install pypi py2
./deploy.sh test installed py2
# Python 3.x # Python 2.x
./deploy.sh remkenv py3 ./deploy.sh remkenv py2
./deploy.sh install pypi py3 ./deploy.sh install pypi py2
./deploy.sh test installed py3 ./deploy.sh test installed py2
```
# Python 3.x
./deploy.sh remkenv py3
./deploy.sh install pypi py3
./deploy.sh test installed py3
have a look at: have a look at:
https://pypi.python.org/pypi/pygcode https://pypi.python.org/pypi/pygcode
@ -178,15 +168,25 @@ to make sure it's sane
# Deployment in Git # Deployment in Git
merge deployed branch to `master`, then... create pull request `develop` -> `master`
``` ## Update change log
git checkout master
git pull update [change log](../dist/README.md)
git tag ${version} -m "<change description>"
git push --tags origin master ## Push Release to Git (aka `tag`)
```
merge `develop` branch to `master`, then...
Switch local to `master` and tag with relevant version
git checkout master
git pull
git tag ${version} -m "<change description>"
git push --tags origin master
have a look at the [releases page](https://github.com/fragmuffin/pygcode/releases) and it should be there. have a look at the [releases page](https://github.com/fragmuffin/pygcode/releases) and it should be there.
edit release and copy relevant content from [change log](../dist/README.md)
tadaaaaaa!... go to sleep; it's probably late tadaaaaaa!... go to sleep; it's probably late