fix opensearch.xml generation

Author: 4www

.github/workflows/static.yml

@@ -15,9 +15,6 @@ concurrency:
   group: "deploy-pages"
   cancel-in-progress: false
 
-env:
-  I4K_FIND_URL: ${{ vars.I4K_FIND_URL }}
-
 jobs:
   deploy:
     environment:
@@ -28,6 +25,10 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
+      - name: Configure GitHub Pages
+        id: pages
+        uses: actions/configure-pages@v5
+
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
@@ -37,11 +38,11 @@ jobs:
         run: npm ci
 
       - name: Generate opensearch.xml
+        env:
+          # Use custom URL if set, otherwise use the GitHub Pages base URL
+          I4K_FIND_URL: ${{ vars.I4K_FIND_URL || steps.pages.outputs.base_url }}
         run: npm run opensearch assets/opensearch.xml
 
-      - name: Configure GitHub Pages
-        uses: actions/configure-pages@v5
-
       - name: Upload Pages artifact
         uses: actions/upload-pages-artifact@v3
         with:

docs/deployment.md

@@ -5,9 +5,14 @@ For more customization, see the development documentation.
 
 ## Methods
 There are diverse possibilities to deploy a new instance with a custom
-Find, generally it will need the correct values for the `I4K_FIND_URL`
-environment variable, `https://example.org/my-find`. As reference,
-check the different CI/CD workflow recipes.
+Find. The OpenSearch configuration is generated from the `I4K_FIND_URL`
+environment variable (e.g., `https://example.org/my-find`).
+
+**For GitHub Pages deployments**: The `I4K_FIND_URL` automatically defaults
+to your repository's GitHub Pages URL, so no manual configuration is needed.
+
+**For custom domains**: Set the `I4K_FIND_URL` environment variable to your
+deployment URL. As reference, check the different CI/CD workflow recipes.
 
 > The recommended method is to use a CI/CD recipe to deploy a custom
 > instance, to a custom server (or pages like the default
@@ -39,11 +44,13 @@ Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=
 ### github fork & actions (for own instance)
 - fork this repository
 - enable "pages from actions" in the settings
-- customize the `I4K_FIND_URL` env var (it will try to default to the
-  github pages deployment URL)
 - run the "static.yml" workflow
 - visit the fork's github page
 
+**Note**: The `I4K_FIND_URL` environment variable automatically defaults to
+your GitHub Pages URL (`https://{owner}.github.io/{repo}/`). You only need
+to set it manually in repository variables if deploying to a custom domain.
+
 ### gitlab pages
 - fork this repository on gitlab
 - it should use the `pages` job/pipeline, that will deploy a new instance

src/scripts/opensearch-xml.js

@@ -1,5 +1,5 @@
 import { OpenSearchDescription } from "../open-search.js";
-import packageJson from "../../package.json" assert { type: "json" };
+import packageJson from "../../package.json" with { type: "json" };
 import fs from "fs/promises";
 import path from "path";
 
@@ -48,9 +48,13 @@ const openSearchXml = async () => {
 	const { I4K_FIND_URL } = process.env;
 
 	if (!I4K_FIND_URL) {
+		console.error("ERROR: I4K_FIND_URL environment variable is not set");
+		console.error("The OpenSearch XML file will not be generated.");
 		return;
 	}
 
+	console.log(`Generating OpenSearch XML for: ${I4K_FIND_URL}`);
+
 	let osdXml;
 	try {
 		const newConfig = await newUserConfig(I4K_FIND_URL);
@@ -65,6 +69,7 @@ const openSearchXml = async () => {
 		try {
 			const localPath = path.join(process.cwd(), OSD_PATH);
 			await fs.writeFile(localPath, osdXml);
+			console.log(`✓ OpenSearch XML written to: ${localPath}`);
 		} catch (e) {
 			throw e;
 		}