Add configobj as a submodule (#157)

* Add configobj as a submodule

* Add submodule init

* Change submodule init and remove sudo

* Reorganize steps

* Update docs for development version

* Update unit tests

.github/workflows/linux.yml

@@ -66,27 +66,30 @@ jobs:
       image: fedora:latest
       options: --privileged
     steps:
-    - uses: actions/[email protected]
-      with:
-        submodules: false
     - name: Configure container environment
       run: |
         sudo dnf update -y
         sudo dnf install -y git
         git config --global --add safe.directory ${GITHUB_WORKSPACE}
+    - uses: actions/[email protected]
+      with:
+        submodules: false
     - name: Setup environment
       run: |
         sudo dnf install -y sdl12-compat python3-wxpython4 xorg-x11-server-Xvfb python3-pip psmisc
         sudo dnf downgrade -y mesa* --refresh
-        sudo -H pip install -r requirements-dev.txt
+        git submodule update --init --recursive
+        pip install -r requirements-dev.txt
     - name: Run tests
       run: |
         Xvfb &
         export DISPLAY=:0
         export GITHUB_ACTIONS=True
+        git submodule update --init --recursive
         invoke test-ci
     - name: Install and run
       run: |
+        git submodule update --init --recursive
         pip install .
         xvfb-run --server-args="-screen 0, 1280x720x24" -a ride.py &
         sleep 10
@@ -103,20 +106,24 @@ jobs:
         submodules: false
     - name: Fetch tags
       run: |
-        git fetch --prune --depth=1 --no-recurse-submodules
+        git fetch --prune --depth=1 --recurse-submodules
+        git submodule update --init --recursive
     - name: Setup environment
       run: |
         sudo apt update -y
         sudo apt install -y libsdl1.2debian libsdl2-2.0-0 libnotify4
-        sudo pip install https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-22.04/wxPython-4.2.1-cp310-cp310-linux_x86_64.whl
-        sudo pip install -r requirements-dev.txt
+        git submodule update --init --recursive
+        pip install https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-22.04/wxPython-4.2.1-cp310-cp310-linux_x86_64.whl
+        pip install -r requirements-dev.txt
     - name: Run tests
       run: |
         Xvfb &
         export DISPLAY=:0
+        git submodule update --init --recursive
         invoke test-ci
     - name: Install and run
       run: |
+        git submodule update --init --recursive
         pip install .
         xvfb-run --server-args="-screen 0, 1280x720x24" -a ride.py &
         sleep 10

.github/workflows/sonar.yml

@@ -28,16 +28,19 @@ jobs:
       - name: Install invoke and any other packages
         run: pip install coverage invoke pytest
       - name: Install wxPython
-        run: pip install https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-22.04/wxPython-4.2.0-cp310-cp310-linux_x86_64.whl
+        run: pip install https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-22.04/wxPython-4.2.1-cp310-cp310-linux_x86_64.whl
       - name: Install RIDE dependencies
-        run: pip install -r requirements-dev.txt
+        run: git submodule update --init --recursive
+             pip install -r requirements-dev.txt
       - name: Run Xvfb
         run: Xvfb :1 -noreset &
       - name: Test Install RIDE
-        run: pip install .
+        run: git submodule update --init --recursive
+             pip install .
       - name: Run RIDE unit-tests
         run: |
           export DISPLAY=:1
+          git submodule update --init --recursive
           invoke test-ci
       - name: Analyze with SonarCloud
         uses: sonarsource/sonarcloud-github-action@master

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "src/robotide/preferences/configobj"]
+	path = src/robotide/preferences/configobj
+	url = https://github.com/DiffSK/configobj.git

CHANGELOG.adoc

@@ -7,7 +7,12 @@ The format is based on http://keepachangelog.com/en/1.0.0/[Keep a Changelog]
 and this project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioning].
 
 
-// == https://github.com/robotframework/RIDE[Unreleased]
+== https://github.com/robotframework/RIDE[Unreleased]
+
+=== Changed
+
+- Changed the workflow for the development versions of RIDE. Now, development versions are taken from the ``develop`` branch, and the ``master`` will stay with released version.
+- Changed the way ``configobj`` code is imported. Now is a submodule obtained from https://github.com/DiffSK/configobj.
 
 == https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.1.rst[2.1] - 2024-10-13
 

MANIFEST.in

@@ -8,5 +8,6 @@ recursive-include src *.css *.js *.py *.robot *.txt *.png *.gif *.ico *.cfg *.ht
 recursive-include doc *.rst
 recursive-include rtest *.py *.txt
 recursive-include src/robotide/postinstall/RIDE.app *.*
+recursive-include src/robotide/preferences/configobj/src/configobj *.*
 recursive-include src/robotide/localization *.py *.adoc *.pot *.po *.mo
 

README.adoc

@@ -22,9 +22,9 @@ You can use the tag *robotframework-ide* to search and ask on https://stackoverf
 
 == **Welcome to the development version of RIDE - next major release will be version 2.2**
 
-// If you are looking for the latest released version, you can get the source code from **https://github.com/robotframework/RIDE/releases[releases]** or from branch **https://github.com/robotframework/RIDE/tree/release/2.0.8.1[release/2.0.8.1]**
+If you are looking for the latest released version, you can get the source code from **https://github.com/robotframework/RIDE/releases[releases]** or from branch **https://github.com/robotframework/RIDE/tree/release/2.1[release/2.1]**
 
-// See the https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.0.8.1.rst[release notes] for latest release version 2.0.8.1
+See the https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.1.rst[release notes] for latest release version 2.1
 
 **Version https://github.com/robotframework/RIDE/tree/release/2.0.8.1[2.0.8.1] was the last release supporting Python 3.6 and 3.7**
 
@@ -36,13 +36,13 @@ You can use the tag *robotframework-ide* to search and ask on https://stackoverf
 Currently, the unit tests are tested on Python 3.10, and 3.12 (which is the recommended version).
 Likewise, the current version of wxPython, is 4.2.2, but RIDE is known to work with 4.0.7 and 4.1.1 versions.
 
-(3.6 <= python <= 3.11) Install current released version (*2.1*) with:
+(3.8 <= python <= 3.12) Install current released version (*2.1*) with:
 
 `pip install -U robotframework-ride`
 
-(3.8 <= python <= 3.12) Install current development version (**2.1**) with:
+(3.8 <= python <= 3.12) Install current development version (**2.1.1**) with:
 
-`pip install -U https://github.com/robotframework/RIDE/archive/master.zip`
+`pip install -U https://github.com/robotframework/RIDE/archive/develop.zip`
 
 //(3.8 <= python <=  3.12) Install current Beta version (2.1b1) with:
 

setup.cfg

@@ -10,6 +10,10 @@ count = False
 max_line_length = 90
 statistics = True
 
+[options]
+packages = find:
+include_package_data = true
+
 [options.entry_points]
 gui_scripts =
     ride = robotide.__main__:main

setup.py

@@ -49,6 +49,14 @@
 
 PACKAGE_DATA['robotide.localization'] = my_list[:]
 
+my_list = []
+for curr_dir, _, files in os.walk('src/robotide/preferences/configobj/src/configobj'):
+    for item in files:
+        if '.' in item:
+             my_list.append(os.path.join(curr_dir, item).replace('\\', '/').replace('src/robotide/preferences/configobj/src/configobj/', ''))
+
+PACKAGE_DATA['robotide.preferences.configobj.src.configobj'] = my_list[:]
+
 LONG_DESCRIPTION = """
 Robot Framework is a generic test automation framework for acceptance
 level testing. RIDE is a lightweight and intuitive editor for Robot
@@ -102,6 +110,7 @@ def run(self):
     url='https://github.com/robotframework/RIDE/',
     download_url='https://pypi.python.org/pypi/robotframework-ride',
     install_requires=REQUIREMENTS,
+    include_package_data=True,
     package_dir={'': SOURCE_DIR},
     packages=find_packages(SOURCE_DIR),
     package_data=PACKAGE_DATA,