mirror of
https://git.mirrors.martin98.com/https://github.com/petaflot/pygcode
synced 2025-08-12 02:29:03 +08:00
added change-log update to deployment checklist
This commit is contained in:
Peter Boin
parent
eb52cd0551
commit
710b968cd8
@ -9,54 +9,52 @@ this can help.
|
||||
|
||||
Method based on the articles:
|
||||
|
||||
* http://peterdowns.com/posts/first-time-with-pypi.html and
|
||||
* https://hynek.me/articles/sharing-your-labor-of-love-pypi-quick-and-dirty/
|
||||
* http://peterdowns.com/posts/first-time-with-pypi.html and
|
||||
* https://hynek.me/articles/sharing-your-labor-of-love-pypi-quick-and-dirty/
|
||||
|
||||
|
||||
Deployment also heavily uses the `./deploy.sh` script in this folder.
|
||||
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:
|
||||
Setup:
|
||||
setup: Installs packages & sets up environment (requires sudo)
|
||||
Arguments:
|
||||
Setup:
|
||||
setup: Installs packages & sets up environment (requires sudo)
|
||||
|
||||
Compiling:
|
||||
build: Execute setup to build packages (populates ../dist/)
|
||||
creates both 'sdist' and 'wheel' distrobutions.
|
||||
Compiling:
|
||||
build: Execute setup to build packages (populates ../dist/)
|
||||
creates both 'sdist' and 'wheel' distrobutions.
|
||||
|
||||
Virtual Environments:
|
||||
rmenv py# Remove virtual environment
|
||||
remkenv py# Remove, then create re-create virtual environment
|
||||
envprereq py# install environment prerequisites (official PyPi)
|
||||
Virtual Environments:
|
||||
rmenv py# Remove virtual environment
|
||||
remkenv py# Remove, then create re-create virtual environment
|
||||
envprereq py# install environment prerequisites (official PyPi)
|
||||
|
||||
Deploy:
|
||||
deploy test Upload to PyPi test server
|
||||
deploy prod Upload to PyPi (official)
|
||||
Deploy:
|
||||
deploy test Upload to PyPi test server
|
||||
deploy prod Upload to PyPi (official)
|
||||
|
||||
Install:
|
||||
install sdist py# Install from local sdist
|
||||
install wheel py# Install from local wheel
|
||||
install pypitest py# Install from PyPi test server
|
||||
install pypi py# Install from PyPi (official)
|
||||
Install:
|
||||
install sdist py# Install from local sdist
|
||||
install wheel py# Install from local wheel
|
||||
install pypitest py# Install from PyPi test server
|
||||
install pypi py# Install from PyPi (official)
|
||||
|
||||
Testing:
|
||||
test dev py# Run tests on local dev in a virtual env
|
||||
test installed py# Run tests on installed library in virtual env
|
||||
Testing:
|
||||
test dev py# Run tests on local dev in a virtual env
|
||||
test installed py# Run tests on installed library in virtual env
|
||||
|
||||
Help:
|
||||
-h | --help display this help message
|
||||
Help:
|
||||
-h | --help display this help message
|
||||
|
||||
py#: when referenced above means
|
||||
'py2' for Python 2.7.12
|
||||
'py3' for Python 3.5.2
|
||||
```
|
||||
py#: when referenced above means
|
||||
'py2' for Python 2.7.12
|
||||
'py3' for Python 3.5.2
|
||||
|
||||
# PyPi deployment
|
||||
|
||||
@ -68,22 +66,20 @@ Arguments:
|
||||
|
||||
`cat ~/.pypirc`
|
||||
|
||||
```
|
||||
[distutils]
|
||||
index-servers =
|
||||
prod
|
||||
test
|
||||
[distutils]
|
||||
index-servers =
|
||||
prod
|
||||
test
|
||||
|
||||
[prod]
|
||||
repository = https://upload.pypi.org/legacy/
|
||||
username=FraggaMuffin
|
||||
password=secret
|
||||
[prod]
|
||||
repository = https://upload.pypi.org/legacy/
|
||||
username=FraggaMuffin
|
||||
password=secret
|
||||
|
||||
[test]
|
||||
repository=https://test.pypi.org/legacy/
|
||||
username=FraggaMuffin
|
||||
password=secret
|
||||
```
|
||||
[test]
|
||||
repository=https://test.pypi.org/legacy/
|
||||
username=FraggaMuffin
|
||||
password=secret
|
||||
|
||||
`chmod 600 ~/.pypirc`
|
||||
|
||||
@ -91,59 +87,56 @@ password=secret
|
||||
## Build and Test `sdist` and `wheel`
|
||||
|
||||
**Build**
|
||||
```
|
||||
./deploy.sh build
|
||||
```
|
||||
|
||||
./deploy.sh build
|
||||
|
||||
**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
|
||||
./deploy.sh remkenv py3
|
||||
./deploy.sh envprereq py3
|
||||
./deploy.sh install sdist py3
|
||||
./deploy.sh test installed py3
|
||||
```
|
||||
# Python 2.x
|
||||
./deploy.sh remkenv py2
|
||||
./deploy.sh envprereq py2
|
||||
./deploy.sh install sdist py2
|
||||
./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`**
|
||||
```
|
||||
# Python 2.x
|
||||
./deploy.sh remkenv py2
|
||||
./deploy.sh install wheel py2
|
||||
./deploy.sh test installed py2
|
||||
|
||||
# Python 3.x
|
||||
./deploy.sh remkenv py3
|
||||
./deploy.sh install wheel py3
|
||||
./deploy.sh test installed py3
|
||||
```
|
||||
# Python 2.x
|
||||
./deploy.sh remkenv py2
|
||||
./deploy.sh install wheel py2
|
||||
./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
|
||||
|
||||
```
|
||||
./deploy.sh deploy test
|
||||
```
|
||||
|
||||
./deploy.sh deploy 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
|
||||
./deploy.sh remkenv py3
|
||||
./deploy.sh envprereq py3
|
||||
./deploy.sh install pypitest py3
|
||||
./deploy.sh test installed py3
|
||||
```
|
||||
# Python 2.x
|
||||
./deploy.sh remkenv py2
|
||||
./deploy.sh envprereq py2
|
||||
./deploy.sh install pypitest py2
|
||||
./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:
|
||||
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'
|
||||
|
||||
```
|
||||
./deploy.sh deploy prod
|
||||
```
|
||||
./deploy.sh deploy prod
|
||||
|
||||
**Test**
|
||||
```
|
||||
# Python 2.x
|
||||
./deploy.sh remkenv py2
|
||||
./deploy.sh install pypi py2
|
||||
./deploy.sh test installed py2
|
||||
|
||||
# Python 3.x
|
||||
./deploy.sh remkenv py3
|
||||
./deploy.sh install pypi py3
|
||||
./deploy.sh test installed py3
|
||||
```
|
||||
# Python 2.x
|
||||
./deploy.sh remkenv py2
|
||||
./deploy.sh install pypi py2
|
||||
./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:
|
||||
https://pypi.python.org/pypi/pygcode
|
||||
@ -178,15 +168,25 @@ to make sure it's sane
|
||||
|
||||
# Deployment in Git
|
||||
|
||||
merge deployed branch to `master`, then...
|
||||
create pull request `develop` -> `master`
|
||||
|
||||
```
|
||||
git checkout master
|
||||
git pull
|
||||
git tag ${version} -m "<change description>"
|
||||
git push --tags origin master
|
||||
```
|
||||
## Update change log
|
||||
|
||||
update [change log](../dist/README.md)
|
||||
|
||||
## 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.
|
||||
|
||||
edit release and copy relevant content from [change log](../dist/README.md)
|
||||
|
||||
tadaaaaaa!... go to sleep; it's probably late
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user