Issue #3323037 by kunal.sachdev, tedbow, Wim Leers: Add comment in every...

Issue #3323037 by kunal.sachdev, tedbow, Wim Leers: Add comment in every release history XML fixture file

automatic_updates_extensions/tests/fixtures/release-history/aaa_update_test.1.1.xml

 <?xml version="1.0" encoding="utf-8"?>
-<!-- Test legacy versions -->
+<!--
+This fixture is used by \Drupal\Tests\automatic_updates_extensions\Functional\UpdaterFormTest.
+
+Contains metadata about the following (fake) releases of aaa_update_test module, all of which are secure, in order:
+- 8.x-3.0, which is in an unsupported branch
+- 8.x-2.1
+- 8.x-2.1-beta1
+- 8.x-2.1-alpha1
+- 8.x-2.0
+- 8.x-2.0-beta1
+- 8.x-2.0-alpha1
+- 8.x-1.1
+- 8.x-1.1-beta1
+- 8.x-1.1-alpha1
+- 8.x-1.0
+- 8.x-1.0-beta1
+- 8.x-1.0-alpha1
+-->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
 <title>AAA Update test</title>
 <short_name>aaa_update_test</short_name>

automatic_updates_extensions/tests/fixtures/release-history/alpha.1.1.0.xml

 <?xml version="1.0" encoding="utf-8"?>
+<!--
+This fixture is used by  \Drupal\Tests\automatic_updates_extensions\Build\ModuleUpdateTest.
+
+Contains metadata about the following (fake) releases of alpha module, all of which are secure, in order:
+- 1.1.0
+- 1.0.0
+-->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
 <title>Alpha</title>
 <short_name>alpha</short_name>

automatic_updates_extensions/tests/fixtures/release-history/automatic_updates_extensions_test_theme.1.1.xml

 <?xml version="1.0" encoding="utf-8"?>
+<!--
+This fixture is used by \Drupal\Tests\automatic_updates_extensions\Functional\UpdaterFormTest.
+
+Contains metadata about the following (fake) releases of automatic_updates_extensions_test_theme, all of which are secure, in order:
+- 3.0.0
+- 8.x-2.1
+- 8.x-2.0
+-->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
   <title>Automatic Updates Extensions Test Theme</title>
   <short_name>automatic_updates_extensions_test_theme</short_name>

automatic_updates_extensions/tests/fixtures/release-history/new_module.1.1.0.xml

 <?xml version="1.0" encoding="utf-8"?>
+<!--
+This fixture is used by  \Drupal\Tests\automatic_updates_extensions\Build\ModuleUpdateTest.
+
+Contains metadata about the following (fake) releases of new_module, all of which are secure, in order:
+- 1.1.0
+- 1.0.0
+-->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
 <title>New Module</title>
 <short_name>new_module</short_name>

automatic_updates_extensions/tests/fixtures/release-history/semver_test.1.1.xml

 <?xml version="1.0" encoding="utf-8"?>
+<!--
+This fixture is used by \Drupal\Tests\automatic_updates_extensions\Functional\UpdaterFormTest.
+
+Contains metadata about the following (fake) releases of semver_test module, all of which are secure, in order:
+- 8.2.0, which is in an unsupported branch
+- 8.1.1
+- 8.1.1-beta1
+- 8.1.1-alpha1
+- 8.1.0
+- 8.1.0-beta1
+- 8.1.0-alpha1
+- 8.0.1
+- 8.0.1-beta1
+- 8.0.1-alpha1
+- 8.0.0
+- 8.0.0-beta1
+- 8.0.0-alpha1
+-->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
 <title>Semver Test</title>
 <short_name>semver_test</short_name>

package_manager/tests/fixtures/release-history/aaa_automatic_updates_test.9.8.2.xml → package_manager/tests/fixtures/release-history/aaa_automatic_updates_test.7.0.1.xml

 <?xml version="1.0" encoding="utf-8"?>
+<!--
+This fixture is used by:
+- \Drupal\Tests\package_manager\Kernel\SupportedReleaseValidatorTest
+- \Drupal\Tests\package_manager\Kernel\ProjectInfoTest
+
+Contains metadata about the following (fake) releases of aaa_automatic_updates_test module, all of which are secure, in order:
+- 7.0.1
+- 7.0.0
+- 7.0.0-alpha1
+- 8.x-6.2
+- 8.x-6.1
+- 8.x-6.0
+- 8.x-6.0-alpha1
+- 7.0.x-dev
+- 8.x-6.x-dev
+-->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
 <title>AAA</title>
 <short_name>aaa_automatic_updates_test</short_name>

package_manager/tests/fixtures/release-history/aaa_update_test.1.1.xml

 <?xml version="1.0" encoding="utf-8"?>
-<!-- Test legacy versions -->
+<!--
+This fixture is used by \Drupal\Tests\package_manager\Kernel\SupportedReleaseValidatorTest.
+
+Contains metadata about the following (fake) releases of aaa_update_test module, all of which are secure, in order:
+- 8.x-3.0, which is in an unsupported branch
+- 8.x-2.1
+- 8.x-2.1-beta1
+- 8.x-2.1-alpha1
+- 8.x-2.0
+- 8.x-2.0-beta1
+- 8.x-2.0-alpha1
+- 8.x-1.1
+- 8.x-1.1-beta1
+- 8.x-1.1-alpha1
+- 8.x-1.0
+- 8.x-1.0-beta1
+- 8.x-1.0-alpha1
+-->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
 <title>AAA Update test</title>
 <short_name>aaa_update_test</short_name>

package_manager/tests/fixtures/release-history/alpha.1.1.0.xml

 <?xml version="1.0" encoding="utf-8"?>
+<!--
+This fixture is used by \Drupal\Tests\package_manager\Build\PackageInstallTest.
+
+Contains metadata about the following (fake) releases of alpha module, all of which are secure, in order:
+- 1.1.0
+- 1.0.0
+-->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
 <title>Alpha</title>
 <short_name>alpha</short_name>

package_manager/tests/fixtures/release-history/drupal.10.0.0.xml

 <?xml version="1.0" encoding="utf-8"?>
 <!--
+This fixture is used by:
+- \Drupal\Tests\package_manager\Kernel\ProjectInfoTest
+- \Drupal\Tests\automatic_updates\Functional\UpdaterFormTest
+
 Contains metadata about the following (fake) releases of Drupal core, all of which are secure, in order:
-* 10.0.0
-* 9.7.2
-* 9.7.1
-* 9.7.0
-* 9.6.1
-* 9.6.0
-* 9.5.1
-* 9.5.0
-* 9.4.0, which is in an unsupported branch
-* 9.7.x-dev
+- 10.0.0
+- 9.7.2
+- 9.7.1
+- 9.7.0
+- 9.6.1
+- 9.6.0
+- 9.5.1
+- 9.5.0
+- 9.4.0, which is in an unsupported branch
+- 9.7.x-dev
 -->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
     <title>Drupal</title>

package_manager/tests/fixtures/release-history/drupal.9.8.0-alpha1.xml

 <?xml version="1.0" encoding="utf-8"?>
 <!--
+This fixture is used by \Drupal\Tests\package_manager\Kernel\ProjectInfoTest.
+
 Contains metadata about the following (fake) releases of Drupal core, all of which are secure, in order:
-* 9.8.0-alpha1
-* 9.7.1
-* 9.7.0
+- 9.8.0-alpha1
+- 9.7.1
+- 9.7.0
 -->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
     <title>Drupal</title>

package_manager/tests/fixtures/release-history/drupal.9.8.0-beta1.xml

 <?xml version="1.0" encoding="utf-8"?>
 <!--
+This fixture is used by \Drupal\Tests\automatic_updates\Functional\UpdaterFormTest.
+
 Contains metadata about the following (fake) releases of Drupal core, in order:
-* 9.8.0-beta1
-* 9.7.0
-* 9.8.x-dev
+- 9.8.0-beta1
+- 9.7.0
+- 9.8.x-dev
 -->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
     <title>Drupal</title>

package_manager/tests/fixtures/release-history/drupal.9.8.1-empty_supported_branches.xml

 <?xml version="1.0" encoding="utf-8"?>
 <!--
+This fixture is used by \Drupal\Tests\package_manager\Kernel\ProjectInfoTest.
+
 Contains metadata about releases of Drupal core with no supported branches:
 -->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">

package_manager/tests/fixtures/release-history/drupal.9.8.1-security.xml

 <?xml version="1.0" encoding="utf-8"?>
 <!--
+This fixture is used by:
+- \Drupal\Tests\automatic_updates_extensions\Build\ModuleUpdateTest
+- \Drupal\Tests\package_manager\Kernel\ProjectInfoTest
+- \Drupal\Tests\automatic_updates\Build\CoreUpdateTest
+- \Drupal\Tests\automatic_updates\Functional\AvailableUpdatesReportTest
+- \Drupal\Tests\automatic_updates\Functional\ClickableHelpTest
+- \Drupal\Tests\automatic_updates\Functional\StatusCheckTest
+- \Drupal\Tests\automatic_updates\Functional\UpdaterFormNoRecommendedReleaseMessageTest
+- \Drupal\Tests\automatic_updates\Kernel\CronUpdaterTest
+- \Drupal\Tests\automatic_updates\Kernel\UpdaterTest
+- \Drupal\Tests\automatic_updates\Kernel\StatusCheck\CronFrequencyValidatorTest
+- \Drupal\Tests\automatic_updates\Kernel\StatusCheck\StatusCheckerTest
+- \Drupal\Tests\automatic_updates\Kernel\StatusCheck\VersionPolicyValidatorTest
+
 Contains metadata about the following (fake) releases of Drupal core, in order:
-* 9.8.1, which is a security release
-* 9.8.0, which is insecure
-* 9.8.0-alpha1, which is insecure
-* 9.8.x-dev
+- 9.8.1, which is a security release
+- 9.8.0, which is insecure
+- 9.8.0-alpha1, which is insecure
+- 9.8.x-dev
 -->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
     <title>Drupal</title>

package_manager/tests/fixtures/release-history/drupal.9.8.1-supported_branches_not_set.xml

 <?xml version="1.0" encoding="utf-8"?>
 <!--
+This fixture is used by \Drupal\Tests\package_manager\Kernel\ProjectInfoTest.
+
 Contains metadata about releases of Drupal core with <supported_branches></supported_branches> not set:
 -->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">

package_manager/tests/fixtures/release-history/drupal.9.8.2-older-sec-release.xml

 <?xml version="1.0" encoding="utf-8"?>
 <!--
+This fixture is used by:
+- \Drupal\Tests\package_manager\Kernel\ProjectInfoTest
+- \Drupal\Tests\automatic_updates\Functional\AvailableUpdatesReportTest
+- \Drupal\Tests\automatic_updates\Kernel\ReleaseChooserTest
+
 Contains metadata about the following (fake) releases of Drupal core, in order:
-* 9.8.2
-* 9.8.1, which is a security update
-* 9.8.1-beta1, which is a security update
-* 9.8.0, which is insecure
-* 9.8.0-alpha1
-* 9.7.1, which is a security update
-* 9.7.0, which is insecure
-* 9.7.0-alpha1
-* 9.8.x-dev
+- 9.8.2
+- 9.8.1, which is a security update
+- 9.8.1-beta1, which is a security update
+- 9.8.0, which is insecure
+- 9.8.0-alpha1
+- 9.7.1, which is a security update
+- 9.7.0, which is insecure
+- 9.7.0-alpha1
+- 9.8.x-dev
 -->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
     <title>Drupal</title>

package_manager/tests/fixtures/release-history/drupal.9.8.2-unsupported_unpublished.xml

 <?xml version="1.0" encoding="utf-8"?>
 <!--
+This fixture is used by:
+- \Drupal\Tests\package_manager\Kernel\ProjectInfoTest
+- \Drupal\Tests\automatic_updates\Kernel\StatusCheck\VersionPolicyValidatorTest
+
 Contains metadata about the following (fake) releases of Drupal core, in order:
-* 9.8.2
-* 9.8.1, which is unsupported
-* 9.8.0, which is unpublished
-* 9.8.0-alpha1
-* 9.7.1
-* 9.7.0
-* 9.7.0-alpha1
-* 9.6.1, which is in an unsupported branch
-* 9.6.0, which is in an unsupported branch
-* 9.6.0, which is in an unsupported branch
-* 9.8.x-dev
+- 9.8.2
+- 9.8.1, which is unsupported
+- 9.8.0, which is unpublished
+- 9.8.0-alpha1
+- 9.7.1
+- 9.7.0
+- 9.7.0-alpha1
+- 9.6.1, which is in an unsupported branch
+- 9.6.0, which is in an unsupported branch
+- 9.6.0, which is in an unsupported branch
+- 9.8.x-dev
 -->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
     <title>Drupal</title>

package_manager/tests/fixtures/release-history/drupal.9.8.2.xml

 <?xml version="1.0" encoding="utf-8"?>
 <!--
+This fixture is used by:
+- \Drupal\Tests\automatic_updates_extensions\Functional\UpdaterFormTest
+- \Drupal\Tests\automatic_updates_extensions\Kernel\Validator\UpdateReleaseValidatorTest
+- \Drupal\Tests\package_manager\Kernel\ProjectInfoTest
+- \Drupal\Tests\package_manager\Kernel\SupportedReleaseValidatorTest
+- \Drupal\Tests\automatic_updates\Functional\AvailableUpdatesReportTest
+- \Drupal\Tests\automatic_updates\Functional\UpdaterFormNoRecommendedReleaseMessageTest
+- \Drupal\Tests\automatic_updates\Functional\UpdaterFormTest
+- \Drupal\Tests\automatic_updates\Kernel\CronUpdaterTest
+- \Drupal\Tests\automatic_updates\Kernel\StatusCheck\VersionPolicyValidatorTest
+- \Drupal\Tests\automatic_updates\Kernel\StatusCheck\VersionPolicy\SupportedBranchInstalledTest
+
 Contains metadata about the following (fake) releases of Drupal core, all of which are secure, in order:
-* 9.8.2
-* 9.8.1
-* 9.8.0
-* 9.8.0-alpha1
-* 9.7.1
-* 9.7.0
-* 9.7.0-alpha1
-* 9.6.1, which is in an unsupported branch
-* 9.6.0, which is in an unsupported branch
-* 9.6.0, which is in an unsupported branch
-* 9.8.x-dev
+- 9.8.2
+- 9.8.1
+- 9.8.0
+- 9.8.0-alpha1
+- 9.7.1
+- 9.7.0
+- 9.7.0-alpha1
+- 9.6.1, which is in an unsupported branch
+- 9.6.0, which is in an unsupported branch
+- 9.6.0, which is in an unsupported branch
+- 9.8.x-dev
 -->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
     <title>Drupal</title>

package_manager/tests/fixtures/release-history/drupal.9.8.2_unknown_status.xml

 <?xml version="1.0" encoding="utf-8"?>
 <!--
+This fixture is used by \Drupal\Tests\package_manager\Kernel\ProjectInfoTest.
+
 Contains metadata about the following (fake) releases of Drupal core, in order:
-* 9.8.2
-* 9.8.1
-* 9.8.0
-* 9.8.0-alpha1
-* 9.7.1
-* 9.7.0
-* 9.7.0-alpha1
-* 9.6.1, which is in an unsupported branch
-* 9.6.0, which is in an unsupported branch
-* 9.6.0, which is in an unsupported branch
-* 9.8.x-dev
+- 9.8.2
+- 9.8.1
+- 9.8.0
+- 9.8.0-alpha1
+- 9.7.1
+- 9.7.0
+- 9.7.0-alpha1
+- 9.6.1, which is in an unsupported branch
+- 9.6.0, which is in an unsupported branch
+- 9.6.0, which is in an unsupported branch
+- 9.8.x-dev
 
 What's special about this file is that the project as a whole has a status other than "published".
 -->

package_manager/tests/fixtures/release-history/semver_test.1.1.xml

 <?xml version="1.0" encoding="utf-8"?>
+<!--
+This fixture is used by \Drupal\Tests\package_manager\Kernel\SupportedReleaseValidatorTest.
+
+Contains metadata about the following (fake) releases of semver_test module, all of which are secure, in order:
+- 8.2.0, which is in an unsupported branch
+- 8.1.1
+- 8.1.1-beta1
+- 8.1.1-alpha1
+- 8.1.0
+- 8.1.0-beta1
+- 8.1.0-alpha1
+- 8.0.1
+- 8.0.1-beta1
+- 8.0.1-alpha1
+- 8.0.0
+- 8.0.0-beta1
+- 8.0.0-alpha1
+-->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
 <title>Semver Test</title>
 <short_name>semver_test</short_name>

package_manager/tests/fixtures/release-history/updated_module.1.1.0.xml

 <?xml version="1.0" encoding="utf-8"?>
+<!--
+This fixture is used by \Drupal\Tests\package_manager\Build\PackageUpdateTest.
+
+Contains metadata about the following (fake) releases of updated_module, all of which are secure, in order:
+- 1.1.0
+- 1.0.0
+-->
 <project xmlns:dc="http://purl.org/dc/elements/1.1/">
 <title>Updated Module</title>
 <short_name>updated_module</short_name>