forked from BRCDcomm/pybvc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhowToReleaseNewVersion.txt
49 lines (41 loc) · 1.3 KB
/
howToReleaseNewVersion.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
When you are ready to release a new version of pybvc then follow these steps.
UPDATE VERSION:
---------------
1. Update VERSION in the file pybvc/__init__.py
- X.Y.Z
- Increment Z when you fix something
- Increment Y when you add a new feature
- Increment X when you break backwards-compatibility or add major features
2. Update 'version' and 'release' in file docs/source/conf.py
PUSH TO GITHUB:
---------------
git add .
git commit -m "Update to version <version>"
git push
go to github/<your repository> and do a pull request
UPDATE DOCS:
------------
See howToUpdateDocs.txt
CREATE VERSION ON GITHUB:
-------------------------
Go to: https://github.com/brcdcomm/pybvc
Click the ‘Release’ link near top
Click ‘Draft New Release’
Tag version: x.y.z (e.g. 1.0.4)
Release Title: Version x.y.z
Describe Release: bullet list of major changes. Example markdown:
## Changes:
* Tested with BVC 1.2.0
* Tested with Python 2.7.x
* Added OpenFlow classes
UPDATE PyPi
-----------
In the file pybvc/__init.py__ make sure it has the contents:
__title__ = 'pybvc'
__version__ = '1.2.0'
__author__ = 'Sergei Garbuzov'
__license__ = 'BSD'
__copyright__ = 'Brocade Communications'
Change __version__ to match the new version you are releasing.
python setup.py register -r pypi
python setup.py sdist upload -r pypi