Update README and GitHub client to change repository description updates to homepage URL updates in one-entry mode. Add tests for the new homepage update functionality.

Author: cyanxiao

README.md

@@ -12,7 +12,7 @@ A GitHub Action that automatically converts markdown files in your repository to
 - 📋 Maintains a mapping file of all created pages
 - ⚙️ Configurable file patterns for inclusion/exclusion
 - 🎯 Uses existing Telegraph account or creates a new one
-- 🔀 **One Entry Mode**: Automatically updates repository description with Telegraph URL when only one page is created
+- 🔀 **One Entry Mode**: Automatically updates repository homepage URL with Telegraph URL when only one page is created
 - 🔄 **Page Replacement**: Reuse existing Telegraph pages instead of creating new ones (maintains same URLs)
 
 ## Usage
@@ -88,17 +88,17 @@ jobs:
 
 ## Inputs
 
-| Input                    | Description                                                 | Required | Default                  |
-| ------------------------ | ----------------------------------------------------------- | -------- | ------------------------ |
-| `account-name`           | Telegraph account short name                                | No       | `'GitHub Action'`        |
-| `author-name`            | Author name for Telegraph pages                             | No       | `'GitHub Action'`        |
-| `author-url`             | Author URL for Telegraph pages                              | No       | -                        |
-| `include-patterns`       | Comma-separated glob patterns for files to include          | No       | `'**/*.md'`              |
-| `exclude-patterns`       | Comma-separated glob patterns for files to exclude          | No       | `'node_modules/**'`      |
-| `output-file`            | Output file to store page mappings                          | No       | `'telegraph-pages.json'` |
-| `telegraph-token`        | Existing Telegraph access token                             | No       | -                        |
-| `one-entry-mode`         | Update repository description when only one page is created | No       | `'false'`                |
-| `replace-existing-pages` | Reuse existing Telegraph pages instead of creating new ones | No       | `'false'`                |
+| Input                    | Description                                                  | Required | Default                  |
+| ------------------------ | ------------------------------------------------------------ | -------- | ------------------------ |
+| `account-name`           | Telegraph account short name                                 | No       | `'GitHub Action'`        |
+| `author-name`            | Author name for Telegraph pages                              | No       | `'GitHub Action'`        |
+| `author-url`             | Author URL for Telegraph pages                               | No       | -                        |
+| `include-patterns`       | Comma-separated glob patterns for files to include           | No       | `'**/*.md'`              |
+| `exclude-patterns`       | Comma-separated glob patterns for files to exclude           | No       | `'node_modules/**'`      |
+| `output-file`            | Output file to store page mappings                           | No       | `'telegraph-pages.json'` |
+| `telegraph-token`        | Existing Telegraph access token                              | No       | -                        |
+| `one-entry-mode`         | Update repository homepage URL when only one page is created | No       | `'false'`                |
+| `replace-existing-pages` | Reuse existing Telegraph pages instead of creating new ones  | No       | `'false'`                |
 
 ## Outputs
 
@@ -109,13 +109,13 @@ jobs:
 
 ## One Entry Mode
 
-When enabled with `one-entry-mode: "true"`, this feature automatically updates your repository description with the Telegraph URL when exactly one markdown file is processed. This is perfect for single-page documentation repositories, personal profiles, or project showcases.
+When enabled with `one-entry-mode: "true"`, this feature automatically updates your repository homepage URL with the Telegraph URL when exactly one markdown file is processed. This is perfect for single-page documentation repositories, personal profiles, or project showcases.
 
 ### How One Entry Mode Works
 
 1. **Enable the feature**: Set `one-entry-mode: "true"` in your workflow
 2. **Single page detection**: When exactly one markdown file is processed, the action detects this scenario
-3. **Repository update**: The GitHub repository description is automatically updated with the Telegraph page URL
+3. **Repository update**: The GitHub repository homepage URL is automatically updated with the Telegraph page URL
 4. **Permission handling**: Gracefully handles cases where the GitHub token lacks repository write permissions
 
 ### One Entry Mode Example
@@ -140,11 +140,11 @@ When enabled with `one-entry-mode: "true"`, this feature automatically updates y
     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-**Result**: If only `README.md` is processed, your repository description will be automatically updated to point to the Telegraph page (e.g., `https://telegra.ph/My-Profile-12-15`).
+**Result**: If only `README.md` is processed, your repository homepage URL will be automatically updated to point to the Telegraph page (e.g., `https://telegra.ph/My-Profile-12-15`).
 
 ### One Entry Mode Requirements
 
-- **GITHUB_TOKEN**: Must be provided via `env` for repository description updates
+- **GITHUB_TOKEN**: Must be provided via `env` for repository homepage updates
 - The GitHub token must have `metadata: write` or `contents: write` permissions
 - If permissions are insufficient, the action will show a warning but continue successfully
 - Only works when exactly one markdown file is processed

src/__tests__/github-client.test.ts

@@ -185,6 +185,47 @@ describe("GitHubClient", () => {
     });
   });
 
+  describe("updateRepositoryHomepage", () => {
+    beforeEach(() => {
+      client = new GitHubClient();
+    });
+
+    it("should update repository homepage URL successfully", async () => {
+      const homepageUrl = "https://telegra.ph/My-Page-123";
+
+      mockOctokit.rest.repos.update.mockResolvedValue({});
+
+      await client.updateRepositoryHomepage(homepageUrl);
+
+      expect(mockOctokit.rest.repos.update).toHaveBeenCalledWith({
+        owner: "test-owner",
+        repo: "test-repo",
+        homepage: homepageUrl,
+      });
+
+      expect(core.info).toHaveBeenCalledWith(
+        `Updating repository homepage URL to: ${homepageUrl}`
+      );
+      expect(core.info).toHaveBeenCalledWith(
+        "✅ Repository homepage URL updated successfully"
+      );
+    });
+
+    it("should handle update errors", async () => {
+      const homepageUrl = "https://telegra.ph/My-Page-123";
+      const error = new Error("Insufficient permissions");
+
+      mockOctokit.rest.repos.update.mockRejectedValue(error);
+
+      await expect(
+        client.updateRepositoryHomepage(homepageUrl)
+      ).rejects.toThrow("Insufficient permissions");
+      expect(core.error).toHaveBeenCalledWith(
+        "Failed to update repository homepage URL: Error: Insufficient permissions"
+      );
+    });
+  });
+
   describe("checkPermissions", () => {
     beforeEach(() => {
       client = new GitHubClient();

src/github-client.ts

@@ -77,6 +77,28 @@ export class GitHubClient {
     }
   }
 
+  /**
+   * Update repository homepage URL
+   */
+  async updateRepositoryHomepage(homepageUrl: string): Promise<void> {
+    try {
+      const { owner, repo } = this.getCurrentRepository();
+
+      core.info(`Updating repository homepage URL to: ${homepageUrl}`);
+
+      await this.octokit.rest.repos.update({
+        owner,
+        repo,
+        homepage: homepageUrl,
+      });
+
+      core.info(`✅ Repository homepage URL updated successfully`);
+    } catch (error) {
+      core.error(`Failed to update repository homepage URL: ${error}`);
+      throw error;
+    }
+  }
+
   /**
    * Check if the current GitHub token has the necessary permissions
    */

src/index.ts

@@ -186,34 +186,32 @@ export async function run(): Promise<void> {
     if (config.oneEntryMode && newMappings.length === 1) {
       try {
         core.info(
-          "One entry mode enabled and exactly one page created. Updating repository description..."
+          "One entry mode enabled and exactly one page created. Updating repository homepage URL..."
         );
 
         const githubClient = new GitHubClient();
         const hasPermissions = await githubClient.checkPermissions();
 
         if (hasPermissions) {
           const singlePage = newMappings[0];
-          await githubClient.updateRepositoryDescription(
-            singlePage.telegraphUrl
-          );
+          await githubClient.updateRepositoryHomepage(singlePage.telegraphUrl);
           core.info(
-            `✅ Repository description updated with Telegraph URL: ${singlePage.telegraphUrl}`
+            `✅ Repository homepage URL updated with Telegraph URL: ${singlePage.telegraphUrl}`
           );
         } else {
           core.warning(
-            "GitHub token does not have sufficient permissions to update repository description. Please ensure the token has 'metadata: write' or 'contents: write' permissions."
+            "GitHub token does not have sufficient permissions to update repository homepage URL. Please ensure the token has 'metadata: write' or 'contents: write' permissions."
           );
         }
       } catch (error) {
         core.warning(
-          `Failed to update repository description in one entry mode: ${error}`
+          `Failed to update repository homepage URL in one entry mode: ${error}`
         );
         // Don't fail the entire action for this feature
       }
     } else if (config.oneEntryMode && newMappings.length !== 1) {
       core.info(
-        `One entry mode enabled but ${newMappings.length} pages were created. Repository description will not be updated.`
+        `One entry mode enabled but ${newMappings.length} pages were created. Repository homepage URL will not be updated.`
       );
     }