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

Create new release

Author: bjoernricks

CHANGELOG.md

@@ -4,16 +4,12 @@ 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.1.0] - 2019-03-28
 
 ### Changed
 
 * Changed git repository location to https://github.com/greenbone/autohooks-plugin-black
 * Allow to configure files to be formatted [#1](https://github.com/greenbone/autohooks-plugin-black/pull/1)
 * Use new autohooks status API to print messages [#2](https://github.com/greenbone/autohooks-plugin-black/pull/2)
 
-### Removed
-
-### Fixed
+[1.1.0]: https://github.com/greenbone/autohooks-plugin-black/compare/v1.0.0...v1.1.0

MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md CHANGELOG.md LICENSE pyproject.toml setup.py Pipfile Pipfile.lock
+recursive-include tests *.py

RELEASE.md

@@ -0,0 +1,143 @@
+# Release instructions
+
+Before creating a new release please do a careful consideration about the
+version number for the new release. We are following [Semantic Versioning](https://semver.org/)
+and [PEP440](https://www.python.org/dev/peps/pep-0440/).
+
+* Install development dependencies
+
+  ```sh
+  pipenv install --dev
+  ```
+
+* Fetch upstream changes and create release branch
+
+  ```sh
+  git fetch upstream
+  git checkout -b create-new-release upstream/master
+  ```
+
+* Open [setup.py](setup.py)
+  and increment the version number.
+
+* Update [CHANGELOG](CHANGELOG.md)
+
+* Create a distribution files
+
+  ```sh
+  rm -rf dist build autohooks_plugin_black.egg-info
+  python3 setup.py sdist bdist_wheel
+  ```
+
+* Create a git commit
+
+  ```sh
+  git add .
+  git commit -m "Prepare release <version>"
+  ```
+
+* Create a pypirc 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 -r testpypi dist/*
+  ```
+
+* Check if the package is available at https://test.pypi.org/project/autohooks-plugin-black
+
+* Create a test directory
+
+  ```sh
+  mkdir autohooks-install-test
+  cd autohooks-install-test
+  pipenv run pip install --pre -I --extra-index-url https://test.pypi.org/simple/ autohooks-plugin-black
+  ```
+
+* Remove test environment
+
+  ```sh
+  pipenv --rm
+  cd ..
+  rm -rf autohooks-install-test
+  ```
+
+* Create a release PR
+
+  ```sh
+  git push origin
+  ```
+  Open GitHub and create a PR against https://github.com/greenbone/autohooks-plugin-black
+
+* Update after PR is merged
+
+  ```sh
+  git fetch upstream
+  git rebase upstream/master
+  ```
+* Create a git tag
+
+  ```sh
+  git tag v<version>
+  ```
+
+  or even signed with your gpg key
+
+  ```sh
+  git tag -s v<version>
+  ```
+* Create final distribution files
+
+  ```sh
+  rm -rf dist build autohooks_plugin_black.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/autohooks-plugin-black
+
+* Update version in [setup.py](setup.py)
+
+  Use a alpha version like `(1, 1, 1, 'alpha')` or
+  `(1, 1, 1, 'alpha', 0)`
+
+* Create a commit
+
+  ```sh
+  git commit -m "Update version after <version> release"
+  ```
+
+* Push changes and tag to GitHub
+
+  ```sh
+  git push --tags upstream master
+  ```

setup.py

@@ -18,7 +18,7 @@
 from pkg_resources import safe_version
 from setuptools import setup, find_namespace_packages
 
-VERSION = (1, 1, 0, 'alpha')
+VERSION = (1, 1, 0)
 
 
 def get_version():