Merge pull request #155 from bjoernricks/create-new-release

Create new release

CHANGELOG.md

@@ -4,9 +4,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
-
-### Added
+## [1.0.0] - 2019-09-18
 
 ### Changed
 * Return version tuple from get_protocol_version methods [#154](https:/greenbone/python-gvm/pull/154)
@@ -17,9 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Re-added `SMB` as an allowed `AlertMethod` for SecInfo events
  [PR 145](https:/greenbone/python-gvm/pull/145)
 
-### Removed
-
-[Unreleased]: https:/greenbone/python-gvm/compare/v1.0.0.beta3...master
+[1.0.0]: https:/greenbone/python-gvm/compare/v1.0.0.beta3...v1.0.0
 
 ## [1.0.0.beta3] - 2019-07-30
 

RELEASE.md

@@ -21,6 +21,9 @@ and [PEP440](https://www.python.org/dev/peps/pep-0440/).
  and increment the version number.
 
 * Update [CHANGELOG.md](https:/greenbone/python-gvm/blob/master/CHANGELOG.md)
+ * Change [unreleased] to new release version
+ * Add a release date
+ * Update reference to Github diff
 
 * Create a source and wheel distribution
 
@@ -35,13 +38,34 @@ and [PEP440](https://www.python.org/dev/peps/pep-0440/).
  git add .
  git commit -m "Prepare release <version>"
  ```
+* Create a pypi configuration file
+
+ ```sh
+ vim ~/.pypirc
+ ```
+
+ with the following content (Note: `<username>` must be replaced)
+
+ ```ini
+ [distutils]
+ index-servers =
+ pypi
+ testpypi
+
+ [pypi]
+ username = <username>
+
+ [testpypi]
+ repository = https://test.pypi.org/legacy/
+ username = <username>
+ ```
 
 * Create an account at [Test PyPI](https://packaging.python.org/guides/using-testpypi/)
 
 * Upload the archives in dist to [Test PyPI](https://test.pypi.org/)
 
  ```sh
- twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+ twine upload -r testpypi dist/*
  ```
 
 * Check if the package is available at https://test.pypi.org/project/python-gvm
@@ -68,15 +92,19 @@ and [PEP440](https://www.python.org/dev/peps/pep-0440/).
  rm -rf python-gvm-install-test
  ```
 
-* Create an account at [PyPI](https://pypi.org/) if not exist already
-
-* Upload to real [PyPI](https://pypi.org/)
+* Create a release PR
 
  ```sh
- twine upload dist/*
+ git push origin
  ```
+ Open GitHub and create a PR against https:/greenbone/python-gvm
 
-* Check if new version is available at https://pypi.org/project/python-gvm
+* Update after PR is merged
+
+ ```sh
+ git fetch upstream
+ git rebase upstream/master
+ ```
 
 * Create a git tag
 
@@ -90,6 +118,22 @@ and [PEP440](https://www.python.org/dev/peps/pep-0440/).
  git tag -s v<version>
  ```
 
+* Create final distribution files
+
+ ```sh
+ rm -rf dist build python_gvm.egg-info
+ python3 setup.py sdist bdist_wheel
+ ```
+* Create an account at [PyPI](https://pypi.org/) if not exist already
+
+* Upload to real [PyPI](https://pypi.org/)
+
+ ```sh
+ twine upload dist/*
+ ```
+
+* Check if new version is available at https://pypi.org/project/python-gvm
+
 * Update version in [gvm/__init__.py](https:/greenbone/python-gvm/blob/master/gvm/__init__.py)
 
  Use a development version like `(1, 0, 0, 'beta', 1, 'dev', 1)` or

gvm/__init__.py

@@ -21,7 +21,7 @@
 
 from pkg_resources import safe_version
 
-VERSION = (1, 0, 0, "beta", 3, "dev", 1)
+VERSION = (1, 0, 0)
 """
 Current Version of python-gvm as a tuple
 """