Merge pull request #226 from bsc-wdc/release-0.4

Release 0.4

CHANGELOG.md

@@ -4,6 +4,28 @@ 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).
 
+## [0.4.0] - 2019-09-16
+### Added
+- Distributed array data structure
+- A basic tutorial notebook
+
+### Changed
+- Updated docker image to PyCOMPSs 2.5
+- Modified the whole library to use distributed arrays instead of Datasets
+(including estimators, examples, etc.)
+- Added 'init' parameter to K-means
+- Updated the developer guide
+
+### Removed
+- Dataset and Subset data structures
+- FFT estimator
+- Methods to load from multiple files
+
+### Fixed
+- Fixed the usage of random state in K-means
+- Some issues in the performance tests
+- Other minor bug fixes
+
 ## [0.3.0] - 2019-06-28
 ### Added
 - The VERSION file
@@ -66,7 +88,8 @@ process.
 
 ### Removed
 
-[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...HEAD
+[Unreleased]: https://github.com/bsc-wdc/dislib/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/bsc-wdc/dislib/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/bsc-wdc/dislib/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/bsc-wdc/dislib/compare/v0.1.0...v0.2.0
 

VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

docs/source/development.rst

@@ -7,46 +7,56 @@ Drafting new releases
 Follow these steps when drafting a new release:
 
 1. Ensure that the master branch is passing the tests and that the `latest
-version of the documentation <https://dislib.bsc.es/en/latest>`_ is
-properly being built.
+   version of the documentation <https://dislib.bsc.es/en/latest>`_ is
+   properly being built.
 
 2. Decide whether to issue a minor or a major release following this
-`guide <https://semver.org/>`_.
+   `guide <https://semver.org/>`_.
 
-3. Update the release number accordingly in the `VERSION
-<https://github.com/bsc-wdc/dislib/blob/master/VERSION>`_ file.
+3. Create and switch to a new branch named ``release-X.Y``.
 
-4. Update the required PyCOMPSs version in the `quickstart guide
-<https://github.com/bsc-wdc/dislib/blob/master/CHANGELOG.md>`_ if necessary.
+4. Update the release number accordingly in the `VERSION
+   <https://github.com/bsc-wdc/dislib/blob/master/VERSION>`_ file.
 
-5. Update the `change log
-<https://github.com/bsc-wdc/dislib/blob/master/CHANGELOG.md>`_.
+5. Update the required PyCOMPSs version in the `quickstart guide
+   <https://github.com/bsc-wdc/dislib/blob/master/QUICKSTART.md>`_ if
+   necessary.
 
-6. Draft a new release in `Github <https://github.com/bsc-wdc/
-dislib/releases>`_ using this `template <https://github
-.com/bsc-wdc/dislib/blob/master/.github/RELEASE_TEMPLATE.md>`_.
+6. Update the `change log
+   <https://github.com/bsc-wdc/dislib/blob/master/CHANGELOG.md>`_.
 
-7. Create and tag a docker image for the release running the following at the
-repo's root (change ``VERSION`` accordingly):
-
- - Create the image:
+7. Update the `performance plot <https://github
+   .com/bsc-wdc/dislib/blob/master/docs/source/performance.png>`_ in the
+   documentation if necessary.
+
+8. Push the release branch with the changes.
+
+9. Merge the newly created branch to the master branch.
+
+10. Draft a new release in `Github <https://github.com/bsc-wdc/
+    dislib/releases>`_ using this `template <https://github
+    .com/bsc-wdc/dislib/blob/master/.github/RELEASE_TEMPLATE.md>`_ using tag
+    name ``vX.Y.Z``.
+
+11. Create and tag a docker image for the release running the following at the
+    repo's root (change ``VERSION`` accordingly):
+
+    - Create the image:
 
-  .. code:: bash
+    .. code:: bash
      
-   docker build -t bscwdc/dislib:VERSION
+       docker build -t bscwdc/dislib:VERSION
    
- - Log in and push it to dockerhub
+    - Log in and push it to dockerhub
 
-  .. code:: bash
-     
-   docker login -u DOCKERHUB_USER -p DOCKERHUB_PASSWORD
-   docker push bscwdc/dislib:VERSION
-
+    .. code:: bash
 
+       docker login -u DOCKERHUB_USER -p DOCKERHUB_PASSWORD
+       docker push bscwdc/dislib:VERSION
 
-8. Create a pip package and upload it to PyPi:
+12. Create a pip package and upload it to PyPi:
 
- .. code:: bash
+    .. code:: bash
 
-  python3 setup.py sdist bdist_wheel
-  python3 -m twine upload dist/*
+     python3 setup.py sdist bdist_wheel
+     python3 -m twine upload dist/*