Add method to use generate release notes endpoint

KnpLabs · Jul 9, 2022 · 2354dce · 2354dce
1 parent 83b8a32
commit 2354dce
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/lib/Github/Api/Repository/Releases.php b/lib/Github/Api/Repository/Releases.php
@@ -68,6 +68,20 @@ public function show($username, $repository, $id)
         return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/releases/'.$id);
     }
 
+    /**
+     * Generate release notes content for a release.
+     *
+     * @param string $username
+     * @param string $repository
+     * @param array  $params
+     *
+     * @return array
+     */
+    public function generateNotes($username, $repository, array $params)
+    {
+        return $this->post('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/releases/generate-notes', $params);
+    }
+
     /**
      * Create new release in selected repository.
      *

diff --git a/test/Github/Tests/Api/Repository/ReleasesTest.php b/test/Github/Tests/Api/Repository/ReleasesTest.php
@@ -76,6 +76,26 @@ public function shouldGetSingleRepositoryRelease()
         $this->assertEquals($expectedValue, $api->show('KnpLabs', 'php-github-api', $id));
     }
 
+    /**
+     * @test
+     */
+    public function shouldGenerateReleaseNotes()
+    {
+        $expectedValue = [
+            'name' => 'Release v1.0.0 is now available!',
+            'body' => '##Changes in Release v1.0.0 ... ##Contributors @monalisa',
+        ];
+        $data = ['tag_name' => 'some-tag'];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('post')
+            ->with('/repos/KnpLabs/php-github-api/releases/generate-notes')
+            ->will($this->returnValue($expectedValue));
+
+        $this->assertEquals($expectedValue, $api->generateNotes('KnpLabs', 'php-github-api', $data));
+    }
+
     /**
      * @test
      */