Merge pull request #39

Rename project to `github-preview-updater`

Author: andrey-helldar

.github/preview-updater.yml

@@ -3,5 +3,5 @@
 image:
     parameters:
         icon: 'photograph'
-        packageManager: 'GitHub Actions uses:'
-        packageName: 'TheDragonCode/preview-updater@v1'
+        packageManager: 'uses:'
+        packageName: 'TheDragonCode/github-preview-updater@v1'

README.md

@@ -37,7 +37,7 @@ jobs:
                     fetch-depth: 0
 
             -   name: Update banner
-                uses: TheDragonCode/preview-updater@v1
+                uses: TheDragonCode/github-preview-updater@v1
                 with:
                     # Personal access token (PAT) used when interacting with Git and GitHub.
                     #
@@ -71,7 +71,7 @@ Create `.github/preview-updater.yml` (or provide your own path via `configPath`)
 All fields are optional—omitted ones fall back to defaults.
 
 ```yaml
-# $schema: https://raw.githubusercontent.com/TheDragonCode/preview-updater/refs/heads/main/resources/schema.json
+# $schema: https://raw.githubusercontent.com/TheDragonCode/github-preview-updater/refs/heads/main/resources/schema.json
 
 path:
     readme: README.md        # Target file to update
@@ -103,7 +103,7 @@ image:
         packageGlobal: false
 
         # By default, the repository name will be used.
-        # For example, for https://github.com/TheDragonCode/preview-updater, it will take `preview-updater`
+        # For example, for https://github.com/TheDragonCode/github-preview-updater, it will take `preview-updater`
         # and convert it to `Preview Updater`.
         title: ''          # Fallbacks to repo name (Title Case)
 

dev.ps1

@@ -1,6 +1,6 @@
 $env:GITHUB_RUN_ID = 123
 $env:GITHUB_EVENT_NAME = "push"
-$env:GITHUB_EVENT_PATH = "TheDragonCode/preview-updater"
+$env:GITHUB_EVENT_PATH = "TheDragonCode/github-preview-updater"
 
 $envFile = ".env"
 

package.json

@@ -24,10 +24,10 @@
     ],
     "license": "MIT",
     "type": "commonjs",
-    "repository": "https://github.com/TheDragonCode/preview-updater",
-    "homepage": "https://github.com/TheDragonCode/preview-updater",
+    "repository": "https://github.com/TheDragonCode/github-preview-updater",
+    "homepage": "https://github.com/TheDragonCode/github-preview-updater",
     "bugs": {
-        "url": "https://github.com/TheDragonCode/preview-updater/issues"
+        "url": "https://github.com/TheDragonCode/github-preview-updater/issues"
     },
     "engines": {
         "node": ">=20.0.0"

resources/schema.json

@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://raw.githubusercontent.com/TheDragonCode/preview-updater/refs/heads/main/resources/schema.json",
+    "$id": "https://raw.githubusercontent.com/TheDragonCode/github-preview-updater/refs/heads/main/resources/schema.json",
     "type": "object",
     "additionalProperties": false,
     "properties": {

tests/helpers/config.ts

@@ -6,7 +6,7 @@ export const rawTestConfig: Config = <Config>{
 
     image: {
         parameters: {
-            packageName: "TheDragonCode/preview-updater",
+            packageName: "TheDragonCode/github-preview-updater",
             title: "Preview Updater",
             description: "Lightweight preview update in your repository",
         },

tests/unit/__snapshots__/preview.test.ts.snap

@@ -4,8 +4,8 @@ exports[`empty 1`] = `
 "# Preview Updater
 
 <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository">
-    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
+    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository">
+    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
 </picture>
 
 "
@@ -15,8 +15,8 @@ exports[`html-tag 1`] = `
 "# Preview Updater
 
 <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository">
-    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
+    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository">
+    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
 </picture>
 
 ## Usage
@@ -29,8 +29,8 @@ exports[`just-text 1`] = `
 "# Preview Updater
 
 <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository">
-    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
+    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository">
+    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
 </picture>
 
 Something
@@ -41,8 +41,8 @@ exports[`with-one-image 1`] = `
 "# Preview Updater
 
 <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository">
-    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
+    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository">
+    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
 </picture>
 
 ## Usage
@@ -55,8 +55,8 @@ exports[`with-one-image-without-header 1`] = `
 "# Preview Updater
 
 <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository">
-    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
+    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository">
+    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
 </picture>
 
 ## Usage
@@ -69,8 +69,8 @@ exports[`with-two-images 1`] = `
 "# Preview Updater
 
 <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository">
-    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
+    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository">
+    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
 </picture>
 
 ## Usage
@@ -83,8 +83,8 @@ exports[`with-two-images-without-header 1`] = `
 "# Preview Updater
 
 <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository">
-    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
+    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository">
+    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
 </picture>
 
 ## Usage
@@ -97,8 +97,8 @@ exports[`without-all 1`] = `
 "# Preview Updater
 
 <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository">
-    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
+    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository">
+    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
 </picture>
 
 ## Usage
@@ -111,8 +111,8 @@ exports[`without-images 1`] = `
 "# Preview Updater
 
 <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository">
-    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fpreview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
+    <source media="(prefers-color-scheme: dark)" srcset="https://banners.beyondco.de/Preview%20Updater.png?theme=dark&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository">
+    <img src="https://banners.beyondco.de/Preview%20Updater.png?theme=light&pattern=topography&style=style_2&fontSize=100px&images=code&packageManager=npm+install&packageName=TheDragonCode%2Fgithub-preview-updater&description=Lightweight+preview+update+in+your+repository" alt="Preview Updater">
 </picture>
 
 ## Usage

tests/unit/filesystem.test.ts

@@ -19,9 +19,9 @@ test("read config", () => {
         defaultConfig.image.parameters.pattern,
     );
 
-    expect(data.image.parameters.packageManager).toBe("GitHub Actions uses:");
+    expect(data.image.parameters.packageManager).toBe("uses:");
     expect(data.image.parameters.packageName).toBe(
-        "TheDragonCode/preview-updater",
+        "TheDragonCode/github-preview-updater",
     );
     expect(data.image.parameters.icon).toBe("photograph");
 });