Fix order of arangodb-branches (4.0 < oem)

Author: Simran-B

.circleci/config.yml

@@ -122,9 +122,10 @@ jobs:
 
             pip install pyyaml requests
 
+            # The list of branches needs to be sorted by name (based on the `name` field in versions.yaml)!
             python3 generate_config.py \
               --workflow << pipeline.parameters.workflow >> \
-              --arangodb-branches << pipeline.parameters.arangodb-3_10 >> << pipeline.parameters.arangodb-3_11 >> << pipeline.parameters.arangodb-oem >> << pipeline.parameters.arangodb-3_12 >> << pipeline.parameters.arangodb-4_0 >> \
+              --arangodb-branches << pipeline.parameters.arangodb-3_10 >> << pipeline.parameters.arangodb-3_11 >> << pipeline.parameters.arangodb-3_12 >> << pipeline.parameters.arangodb-4_0 >> << pipeline.parameters.arangodb-oem >> \
               --arangodb-branch << pipeline.parameters.arangodb-branch >> \
               --release-type << pipeline.parameters.release-type >> \
               --docs-version << pipeline.parameters.docs-version >> \

.circleci/generate_config.py

@@ -18,7 +18,7 @@
 
 ## Load versions
 versions = yaml.safe_load(open("versions.yaml", "r"))
-versions = sorted(versions["/arangodb/"], key=lambda d: d['name']) 
+versions = sorted(versions["/arangodb/"], key=lambda d: d['name'])
 
 
 print(f"Loaded versions {versions}")
@@ -33,7 +33,7 @@
     "--workflow", help="The workflow to trigger", type=str
 )
 parser.add_argument(
-    "--arangodb-branches",  nargs='+', help="The arangodb/arangodb branches to be used for the generate workflow"
+    "--arangodb-branches",  nargs='+', help="The arangodb/arangodb branches to be used for the generate workflow (sorted by name)"
 )
 parser.add_argument(
     "--arangodb-branch", help="The arangodb/arangodb branch to be used for the release workflow", type=str

README.md

@@ -957,6 +957,25 @@ It makes a warning show at the top of every page for that version.
    +              --arangodb-branches << pipeline.parameters.arangodb-3_11 >> << pipeline.parameters.arangodb-3_12 >> << pipeline.parameters.arangodb-4_0 >> \
    ```
 
+Note that the order of the branches is important because the version information
+is looked up based on the index number. The branches need to be ordered according
+to a sorted list of the `name` fields as defined in the `versions.yaml`.
+
+Code excerpt from `generate_config.py`:
+
+```py
+versions = yaml.safe_load(open("versions.yaml", "r"))
+versions = sorted(versions["/arangodb/"], key=lambda d: d['name'])
+
+def workflow_generate(config):
+    # ...
+
+    for i in range(len(versions)):
+        version = versions[i]["name"]
+        # ...
+        branch = args.arangodb_branches[i]
+```
+
 3. In the `toolchain/docker/amd64/docker-compose.yml` file, add an entry under
    `services.toolchain.volumes` for the new version. Simply increment the value
    after `:-/tmp/`. Example: