docs: enforce alphabetically sorted experimental options (#26032)

docs/usage/self-hosted-experimental.md

@@ -14,6 +14,11 @@ We do not follow Semantic Versioning for any experimental variables.
 These variables may be removed or have their behavior changed in **any** version.
 We will try to keep breakage to a minimum, but make no guarantees that an experimental variable will keep working.
 
+## `OTEL_EXPORTER_OTLP_ENDPOINT`
+
+If set, Renovate will export OpenTelemetry data to the supplied endpoint.
+For more information see [the OpenTelemetry docs](opentelemetry.md).
+
 ## `RENOVATE_CACHE_NPM_MINUTES`
 
 If set to any integer, Renovate will use this integer instead of the default npm cache time (15 minutes) for the npm datasource.
@@ -35,11 +40,55 @@ If set to "false" (string), Renovate will remove any existing `package-lock.json
 
 If set to any string, Renovate will use this as the `user-agent` it sends with HTTP requests.
 
+## `RENOVATE_X_AUTODISCOVER_REPO_ORDER`
+
+<!-- prettier-ignore -->
+!!! note
+    For the Forgejo and Gitea platform only.
+
+The order method for autodiscover server side repository search.
+
+Allowed values:
+
+- `asc`
+- `desc`
+
+Default value: `asc`.
+
+## `RENOVATE_X_AUTODISCOVER_REPO_SORT`
+
+<!-- prettier-ignore -->
+!!! note
+    For the Forgejo and Gitea platform only.
+
+The sort method for autodiscover server side repository search.
+
+Allowed values:
+
+- `alpha`
+- `created`
+- `updated`
+- `size`
+- `id`
+
+Default value: `alpha`.
+
+## `RENOVATE_X_DELETE_CONFIG_FILE`
+
+If `true` Renovate tries to delete the self-hosted config file after reading it.
+You can set the config file Renovate should read with the `RENOVATE_CONFIG_FILE` environment variable.
+
+The process that runs Renovate must have the correct permissions to delete the config file.
+
 ## `RENOVATE_X_DOCKER_MAX_PAGES`
 
 If set to an integer, Renovate will use this as max page number for docker tags lookup on docker registries, instead of the default 20 pages.
 This is useful for registries which ignores the `n` parameter in the query string and only return 50 tags per page.
 
+## `RENOVATE_X_EXEC_GPID_HANDLE`
+
+If set, Renovate will terminate the whole process group of a terminated child process spawned by Renovate.
+
 ## `RENOVATE_X_GITLAB_AUTO_MERGEABLE_CHECK_ATTEMPS`
 
 If set to an positive integer, Renovate will use this as the number of attempts to check if a merge request on GitLab is mergable before trying to automerge.
@@ -68,83 +117,34 @@ Suppress the default warning when a deprecated version of Node.js is used to run
 
 Skip initializing `RE2` for regular expressions and instead use Node-native `RegExp` instead.
 
-## `RENOVATE_X_PLATFORM_VERSION`
-
-If set, Renovate will use this string as GitLab server version instead of checking via the GitLab API.
-This can be useful when you use the GitLab `CI_JOB_TOKEN` to authenticate Renovate.
-
-Read [platform details](modules/platform/gitlab/index.md) to learn why we need the server version on GitLab.
-
-## `RENOVATE_X_S3_ENDPOINT`
-
-If set, Renovate will use this string as the `endpoint` when instantiating the AWS S3 client.
-
-## `RENOVATE_X_S3_PATH_STYLE`
-
-If set, Renovate will enable `forcePathStyle` when instantiating the AWS S3 client.
-
-> Whether to force path style URLs for S3 objects (e.g., `https://s3.amazonaws.com//` instead of `https://.s3.amazonaws.com/`)
-
-Source: [AWS S3 documentation - Interface BucketEndpointInputConfig](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/bucketendpointinputconfig.html)
-
-## `RENOVATE_X_EXEC_GPID_HANDLE`
-
-If set, Renovate will terminate the whole process group of a terminated child process spawned by Renovate.
-
-## `RENOVATE_X_DELETE_CONFIG_FILE`
-
-If `true` Renovate tries to delete the self-hosted config file after reading it.
-You can set the config file Renovate should read with the `RENOVATE_CONFIG_FILE` environment variable.
-
-The process that runs Renovate must have the correct permissions to delete the config file.
-
 ## `RENOVATE_X_MERGE_CONFIDENCE_API_BASE_URL`
 
 If set, Renovate will query this API for Merge Confidence data.
 This feature is in private beta.
 
-## `RENOVATE_X_AUTODISCOVER_REPO_SORT`
-
-<!-- prettier-ignore -->
-!!! note
-    For the Forgejo and Gitea platform only.
-
-The sort method for autodiscover server side repository search.
+## `RENOVATE_X_PLATFORM_VERSION`
 
-Allowed values:
+If set, Renovate will use this string as GitLab server version instead of checking via the GitLab API.
+This can be useful when you use the GitLab `CI_JOB_TOKEN` to authenticate Renovate.
 
-- `alpha`
-- `created`
-- `updated`
-- `size`
-- `id`
+Read [platform details](modules/platform/gitlab/index.md) to learn why we need the server version on GitLab.
 
-Default value: `alpha`.
+## `RENOVATE_X_REBASE_PAGINATION_LINKS`
 
-## `RENOVATE_X_AUTODISCOVER_REPO_ORDER`
+If set, Renovate will rewrite GitHub Enterprise Server's pagination responses to use the `endpoint` URL from the Renovate config.
 
 <!-- prettier-ignore -->
 !!! note
-    For the Forgejo and Gitea platform only.
-
-The order method for autodiscover server side repository search.
-
-Allowed values:
-
-- `asc`
-- `desc`
+    For the GitHub Enterprise Server platform only.
 
-Default value: `asc`.
+## `RENOVATE_X_S3_ENDPOINT`
 
-## `RENOVATE_X_REBASE_PAGINATION_LINKS`
+If set, Renovate will use this string as the `endpoint` when instantiating the AWS S3 client.
 
-If set, Renovate will rewrite GitHub Enterprise Server's pagination responses to use the `endpoint` URL from the Renovate config.
+## `RENOVATE_X_S3_PATH_STYLE`
 
-<!-- prettier-ignore -->
-!!! note
-    For the GitHub Enterprise Server platform only.
+If set, Renovate will enable `forcePathStyle` when instantiating the AWS S3 client.
 
-## `OTEL_EXPORTER_OTLP_ENDPOINT`
+> Whether to force path style URLs for S3 objects (e.g., `https://s3.amazonaws.com//` instead of `https://.s3.amazonaws.com/`)
 
-If set, Renovate will export OpenTelemetry data to the supplied endpoint.
-For more information see [the OpenTelemetry docs](opentelemetry.md).
+Source: [AWS S3 documentation - Interface BucketEndpointInputConfig](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/bucketendpointinputconfig.html)

test/documentation.spec.ts

@@ -84,5 +84,20 @@ describe('documentation', () => {
         expect(headers).toEqual(expectedOptions);
       });
     });
+
+    describe('self-hosted-experimental', () => {
+      const doc = fs.readFileSync(
+        'docs/usage/self-hosted-experimental.md',
+        'utf8',
+      );
+
+      const headers = doc
+        .match(/\n## (.*?)\n/g)
+        ?.map((match) => match.substring(4, match.length - 1));
+
+      it('has headers sorted alphabetically', () => {
+        expect(headers).toEqual([...headers!].sort());
+      });
+    });
   });
 });