Bump min PHP version to 8.1 (#28)

* Use PHP 8.1

* Declare properties as readonly

* Upgrade Dependencies

* Make GitHub Actions Workflows compatible

Author: stefanzweifel

.github/workflows/psalm.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.0'
+          php-version: 8.1
           extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick
           coverage: none
 

.github/workflows/run-tests.yml

@@ -9,7 +9,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-latest]
-        php: [8.0, 8.1]
+        php: [8.1]
 
     name: P${{ matrix.php }} - ${{ matrix.os }}
 

app/Actions/AddReleaseNotesToChangelogAction.php

@@ -15,11 +15,11 @@
 class AddReleaseNotesToChangelogAction
 {
     public function __construct(
-        private Markdown                                      $markdown,
-        private FindUnreleasedHeading                         $findUnreleasedHeading,
-        private FindSecondLevelHeadingWithText                $findSecondLevelHeadingWithText,
-        private PlaceReleaseNotesBelowUnreleasedHeadingAction $addNewReleaseNotesWithUnreleasedHeadingToChangelog,
-        private PlaceReleaseNotesAtTheTopAction               $addNewReleaseToChangelog
+        private readonly Markdown                                      $markdown,
+        private readonly FindUnreleasedHeading                         $findUnreleasedHeading,
+        private readonly FindSecondLevelHeadingWithText                $findSecondLevelHeadingWithText,
+        private readonly PlaceReleaseNotesBelowUnreleasedHeadingAction $addNewReleaseNotesWithUnreleasedHeadingToChangelog,
+        private readonly PlaceReleaseNotesAtTheTopAction               $addNewReleaseToChangelog
     ) {
     }
 

app/Actions/ExtractPermalinkFragmentFromHeadingAction.php

@@ -18,7 +18,7 @@
 
 class ExtractPermalinkFragmentFromHeadingAction
 {
-    public function __construct(private GitHubActionsOutput $gitHubActionsOutput)
+    public function __construct(private readonly GitHubActionsOutput $gitHubActionsOutput)
     {
     }
 
@@ -71,9 +71,6 @@ protected function prepareCommonmarkEnvironment(): Environment
     /**
      * Attach Heading Permalink to given ReleaseHeading using
      * the Commonmark Heading Permalink Extension.
-     * @param Heading $releaseHeading
-     * @param Environment $environment
-     * @return Document
      */
     protected function attachPermalinkToHeading(Heading $releaseHeading, Environment $environment): Document
     {
@@ -92,8 +89,6 @@ protected function attachPermalinkToHeading(Heading $releaseHeading, Environment
     /**
      * Parse the rendered HTML as a DOM Document and extract the
      * href attribute from the generated a-tag.
-     * @param string $html
-     * @return string|null
      */
     protected function extractLinkFragmentFromRenderedHtml(string $html): ?string
     {

app/Actions/InsertReleaseNotesInChangelogAction.php

@@ -10,7 +10,7 @@
 
 class InsertReleaseNotesInChangelogAction
 {
-    public function __construct(private PrepareReleaseNotesAction $prepareReleaseNotes)
+    public function __construct(private readonly PrepareReleaseNotesAction $prepareReleaseNotes)
     {
     }
 

app/Actions/PlaceReleaseNotesAtTheTopAction.php

@@ -13,9 +13,9 @@
 class PlaceReleaseNotesAtTheTopAction
 {
     public function __construct(
-        private FindFirstSecondLevelHeading       $findFirstSecondLevelHeading,
-        private CreateNewReleaseHeading           $createNewReleaseHeading,
-        private InsertReleaseNotesInChangelogAction $insertReleaseNotesInChangelogAction
+        private readonly FindFirstSecondLevelHeading       $findFirstSecondLevelHeading,
+        private readonly CreateNewReleaseHeading           $createNewReleaseHeading,
+        private readonly InsertReleaseNotesInChangelogAction $insertReleaseNotesInChangelogAction
     ) {
     }
 

app/Actions/PlaceReleaseNotesBelowUnreleasedHeadingAction.php

@@ -18,11 +18,11 @@
 class PlaceReleaseNotesBelowUnreleasedHeadingAction
 {
     public function __construct(
-        private GenerateCompareUrl                    $generateCompareUrl,
-        private FindSecondLevelHeadingWithText        $findPreviousVersionHeading,
-        private CreateNewReleaseHeadingWithCompareUrl $createNewReleaseHeading,
-        private GitHubActionsOutput                   $gitHubActionsOutput,
-        private InsertReleaseNotesInChangelogAction $insertReleaseNotesInChangelogAction
+        private readonly GenerateCompareUrl                    $generateCompareUrl,
+        private readonly FindSecondLevelHeadingWithText        $findPreviousVersionHeading,
+        private readonly CreateNewReleaseHeadingWithCompareUrl $createNewReleaseHeading,
+        private readonly GitHubActionsOutput                   $gitHubActionsOutput,
+        private readonly InsertReleaseNotesInChangelogAction $insertReleaseNotesInChangelogAction
     ) {
     }
 

app/Actions/PrepareReleaseNotesAction.php

@@ -10,7 +10,7 @@
 
 class PrepareReleaseNotesAction
 {
-    public function __construct(private Markdown $markdown, private ShiftHeadingLevelInDocumentAction $shiftHeadingLevelInDocument)
+    public function __construct(private readonly Markdown $markdown, private readonly ShiftHeadingLevelInDocumentAction $shiftHeadingLevelInDocument)
     {
     }
 

app/CreateNewReleaseHeading.php

@@ -10,7 +10,7 @@
 
 class CreateNewReleaseHeading
 {
-    public function __construct(private ExtractPermalinkFragmentFromHeadingAction $extractPermalinkFragmentFromHeading)
+    public function __construct(private readonly ExtractPermalinkFragmentFromHeadingAction $extractPermalinkFragmentFromHeading)
     {
     }
 

app/CreateNewReleaseHeadingWithCompareUrl.php

@@ -13,9 +13,9 @@
 class CreateNewReleaseHeadingWithCompareUrl
 {
     public function __construct(
-        private GenerateCompareUrl $generateCompareUrl,
-        private GitHubActionsOutput $gitHubActionsOutput,
-        private ExtractPermalinkFragmentFromHeadingAction $extractPermalinkFragmentFromHeading
+        private readonly GenerateCompareUrl $generateCompareUrl,
+        private readonly GitHubActionsOutput $gitHubActionsOutput,
+        private readonly ExtractPermalinkFragmentFromHeadingAction $extractPermalinkFragmentFromHeading
     ) {
     }