Draft: Final python2 version

.gitlab-ci.yml

@@ -1,5 +1,18 @@
-stages:
-    - test
+include:
+  - project: 'dev/sys/sopl/ar-dev'
+    # release branch
+    ref: 'release/3.x'
+    file:
+      - '/ci/templates/default.yml'
+
+variables:
+  AR_CI_CLANG_FORMAT_DISABLE: "true"
+  AR_CI_CLANG_TIDY_DISABLE: "true"
+  AR_CI_CPPCHECK_DISABLE: "true"
+  AR_CI_FLAKE8_DISABLE: "true"
+  AR_CI_YAPF_DISABLE: "true"
+  AR_CI_DOCS_DISABLE: "false"
+  AR_CI_DEPLOY_CONAN_DISABLE: "true"
 
 # From https://docs.gitlab.com/ee/ci/merge_request_pipelines/#excluding-certain-jobs
 .only-default: &only-default
@@ -15,22 +28,41 @@ stages:
     - tags
     - merge_requests
 
+docs_test:
+  extends: .docs_test
+  variables:
+    BUILD_DIR: build
+    CONAN_OPTIONS: ""
+    MAKE_CMD_DOCS: "make docs"
+
+pages:
+  extends: .docs_pages
+  variables:
+    BUILD_DIR: build
+    CONAN_OPTIONS: ""
+    MAKE_CMD_DOCS: "make docs"
+  except:
+    variables:
+      - $AR_CI_DOCS_DISABLE == "true"
+
 test py2-tests:
   <<: *only-default
-  stage: test
+  stage: Test
   tags:
     - Agile_GUI_Docker
   script:
+    - pip2 install setuptools-scm==5.0.2
     - pip2 install --user --force "pytest>=3.5,<5"
     - pip2 install pytest-runner==5.2  # this is py2 compatible, ver 5.3 is not
     - xvfb-run -as "-screen 0 1920x1200x24" python2 setup.py pytest --addopts '-vx -m "(core or gui) and not unstable and not user_input"'
 
 test py3-tests:
   <<: *only-default
-  stage: test
+  stage: Test
   tags:
     - Agile_GUI_Docker
   script:
+    - pip3 install setuptools-scm==5.0.2
     - pip3 install tox
     - xvfb-run -as "-screen 0 1920x1200x24" tox -r -c tox_external.ini -e py36
   coverage: /^TOTAL.+?(\d+\%)$/
@@ -44,7 +76,7 @@ test py3-tests:
 
 test py3-tests-core:
   <<: *only-default
-  stage: test
+  stage: Test
   tags:
     - Agile_GUI_Docker
   script:
@@ -62,7 +94,7 @@ test py3-tests-core:
 
 test py3-memory-test-core:
   <<: *only-default
-  stage: test
+  stage: Test
   tags:
     - Agile_GUI_Docker
   script:

CHANGELOG.rst

@@ -5,25 +5,81 @@ Information about :ref:`RAFCON` changes in each release will be published here.
 details can be found in the `GIT commit log <https://github.com/DLR-RM/RAFCON/commits/develop>`__.
 
 
-Patch releases 0.14.\*
-----------------------
+0.15.3
+"""""""
+
+- Bug Fixes:
+    - Fix bug in LoggingView, which freezes RAFCON
+
+
+0.15.2
+"""""""
+
+- Bug Fixes:
+    - Make operations on the logging console thread-safe
+    - Define a new GUI config called 'MAX_LOGGING_BUFFER_LINES' that determines the maximum lines of the logging buffer. If the number of lines exceeds the config value, the old value will be deleted automatically via clipping.
 
-Next Release
-""""""""""""
 
+0.15.1
+"""""""
+
+- Bug Fixes:
+    - Call 'show_notification' via 'idle_add'
+
+
+0.15.0
+"""""""
 
 - Features:
-    - Add memory leak test
-    - Add states for execution control
-    - Add config option to disable execution history completely
-    - Add additional tests
+    - Libraries can now be renamed and relocated. This includes single libraries, library folders and library root keys
+    - Ctrl+F can be used to search for states
+    - Missing libraries are supported better. In case a library cannot be found, the transitions and data-flows are preserved and added to the dummy-state, which is inserted instead of the library. Furthermore, the dummy-state has the same position and size as the old library state.
+    - New execution-history structure: Define specific consumers for in-memory-execution-history and file-system execution history. Furthermore, another hook was defined such that RAFCON plugins can be used to define further consumers. Watch out: the config values for controlling the execution history changed
+
+
+0.14.11
+"""""""
+
+- Features:
+    - Add search bar for lookup through state machine libraries
+    - Add find usage for finding the usages of state machine libraries
 
 - Bug Fixes:
-    - Fix race condition in 'call_gui_callback'
+    - Fix handling of library interface change
 
-- Miscellaneous:
+
+0.14.10
+"""""""
+
+- Features:
+    - Add new config (``RAISE_ERROR_ON_MISSING_LIBRARY_STATES``) to make Rafcon raise error when loading
 
 
+0.14.9
+""""""
+
+- Features:
+    - add states for execution control
+
+
+0.14.8
+""""""
+
+- Bug Fixes:
+    - Fix py2 support
+
+
+0.14.7
+""""""
+
+- Features:
+    - increase test coverage
+    - add gitlab runners support
+    - differentiate between py3 and py2 dependencies in setup.py
+    - differentiate between EXECUTION_LOG_ENABLE and EXECUTION_LOG_TO_FILESYSTEM_ENABLE config options i.e. keep memory footprint of RAFCON constant
+    - add memory leak test
+    - Fix race condition in 'call_gui_callback'
+
 
 0.14.6
 """"""
@@ -98,7 +154,7 @@ Maintenance release.
 
 - Improvements:
 
-  - most ``[PyGTK]DeprecatedWarning``s are fixed
+  - most ``[PyGTK]DeprecatedWarning``\s are fixed
   - graphical editor: minor performance optimizations
   - specify separators for JSON files: Python 3.4 no longer changes the whitespaces in state machine files
   - override builtins string in JSON files: state machine files generated by Python 2 and 3 are now fully identical
@@ -110,7 +166,7 @@ Maintenance release.
   - better defaults:
 
     - root state is named "root state", further states "[state type] [states counter]"
-    - script of ``ExecutionState``s uses more RAFCON features (``preemptive_wait``, return outcome name)
+    - script of ``ExecutionState``\s uses more RAFCON features (``preemptive_wait``, return outcome name)
     - name of states uses full width of state
 
   - provide RAFCON wheel file
@@ -198,7 +254,7 @@ Patch releases 0.13.\*
   - optimize setup_requires in setup.py (faster installation)
   - mark unreliable tests as unstable
   - define timeouts for all tests
-  
+
 - Bug Fixes:
 
   - :issue_ghe:`689` rafcon cannot run without numpy
@@ -214,15 +270,14 @@ Patch releases 0.13.\*
   - add ExecutionTicker to see activity of state machine with high hierarchy depth
 
 - Improvements:
-  
+
   - changing states (adding or removing) during step mode works now
 
 - Bug Fixes:
 
   - :issue_ghe:`678` script validation does not work
   - :issue_ghe:`663` cannot rename connected data port of type object
-  - :issue_ghe:`684` ``test_simple_execution_model_and_core_destruct_with_gui`` fails when running core & gui tests
-  in a row
+  - :issue_ghe:`684` ``test_simple_execution_model_and_core_destruct_with_gui`` fails when running core & gui tests in a row
   - fix pause and step mode behavior
   - installation of fonts under Python 3
   - various test fixed for Python 3
@@ -259,7 +314,7 @@ Patch releases 0.13.\*
 
 - Changes:
 
-  - Release correct style files 
+  - Release correct style files
 
 
 0.13.2
@@ -425,21 +480,21 @@ Patch releases 0.12.\*
 """""""
 
 - Features:
-    
+
   - maintenance release
 
 0.12.19
 """""""
 
 - Bug Fixes:
-    
+
   - fix setup.py, sdist now working on pypi
 
 0.12.18
 """""""
 
 - Features:
-    
+
   - new shortcut open library state separately as state machine by default on 'Shift+Ctrl+Space' (shortcut works for multiple states, too)
 
 - Improvements:
@@ -583,7 +638,7 @@ Patch releases 0.12.\*
   - copy/paste for semantic data elements
   - new config value SHOW_PATH_NAMES_IN_EXECUTION_HISTORY
   - make library path in state editor overview selectable
-    
+
 - Bug Fixes:
 
   - :issue_ghe:`503` scoped variable looks weird
@@ -896,21 +951,21 @@ Patch releases 0.10.\*
 """"""
 
 - Bug Fixes:
-  
+
   - make execution logs compatible with execution log viewer again
 
 
 0.10.0
 """"""
 
 - Improvements:
-  
+
   - complex actions(copy & paste, resize) are properly handled in gaphas and in the modification history
   - :issue_ghe:`342` drag and drop now drops the state at the mouse position
 
 - Bug Fixes:
-  
-  - show library content for OpenGL works again  
+
+  - show library content for OpenGL works again
   - add as template works again
   - :issue_ghe:`343` Text field does not follow cursor
 
@@ -921,7 +976,7 @@ Patch releases 0.9.\*
 """""
 
 - Improvements:
-  
+
   - execution history can be logged and is configurable via the config.yaml
 
 0.9.7
@@ -993,7 +1048,7 @@ Patch releases 0.9.\*
 """""
 
 - Bug Fix
-  - fix bad storage format in combination with wrong jsonconversion version   
+  - fix bad storage format in combination with wrong jsonconversion version
 
 0.9.0
 """""
@@ -1034,7 +1089,7 @@ Patch releases 0.9.\*
   - :issue_ghe:`251`: Handles are added when hovering over a transition handle
   - :issue_ghe:`259`: Do not hard code version in about dialog
   - :issue_ghe:`260`: Meta data is loaded several times
-  
+
 
 Patch releases 0.8.\*
 ---------------------
@@ -1062,7 +1117,7 @@ Patch releases 0.8.\*
 
 0.8.1
 """""
-  
+
 - Features:
 
   - renaming of module paths: core instead of state machine; gui instead of mvc
@@ -1604,4 +1659,4 @@ Patch releases 0.2.\*
 """""
 
 - First release version
-- Tool was renamed to RAFCON
+- Tool was renamed to RAFCON

CITATION.cff

@@ -3,7 +3,7 @@
 cff-version: "1.0.3"
 message: "If you use this software, please cite it using these metadata."
 title: RAFCON
-version: 0.14
+version: 0.15
 date-released: 2019-07-29
 license: EPL-1.0
 doi: "10.5281/zenodo.1493058"

Makefile

@@ -0,0 +1,27 @@
+.PHONY: all docs build clean help
+
+
+all: docs
+
+
+# generate build folders
+build:
+	mkdir -p build/docs
+
+docs: build
+	echo "$(dirname "$1")"
+	pip3 install virtualenv || return -1
+	python3 -m virtualenv venv --system-site-packages || return -1
+	# Don't use the source command since not all shells support it.
+	. venv/bin/activate;\
+	pip3 install -r requirements-py3.txt;\
+	sphinx-build -v -b html doc build/docs/html
+
+clean:
+	rm -rf build
+	rm -rf venv
+
+help:
+	@echo "Available Targets:"
+	@echo "... all"
+	@echo "... docs"