2 Commits

Author SHA1 Message Date
Ignacio Ballesteros
3b24386dd0 ci: add rolling 'release' tag job to keep update.json current
Some checks failed
Release / build (push) Failing after 1m38s
Release / update-rolling-release (push) Has been skipped
Add a second CI job that runs after the versioned release is published.
It upserts a permanent Gitea release tagged 'release', replacing its
assets with the freshly built update.json and update-beta.json.
This is the URL Zotero polls for auto-update checks per manifest.json.
2026-02-17 22:45:39 +01:00
Ignacio Ballesteros
e356f50927 fix: patch scaffold URL parser to support self-hosted Gitea (.eu TLD)
zotero-plugin-scaffold hardcodes a .com-only regex in parseRepoUrl,
causing build failures with non-.com repository URLs. Add:
- scripts/patch-scaffold.mjs: postinstall script that fixes the regex
- zotero-plugin.config.ts: explicit xpiDownloadLink and updateURL
  so scaffold generates correct update.json without relying on the parser
2026-02-17 22:42:48 +01:00
4 changed files with 165 additions and 10 deletions

View File

@@ -8,6 +8,9 @@ on:
jobs:
build:
runs-on: ubuntu-latest
outputs:
version: ${{ steps.version.outputs.version }}
tag: ${{ steps.version.outputs.tag }}
steps:
- name: Checkout
@@ -27,19 +30,20 @@ jobs:
- name: Get version
id: version
run: echo "version=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
run: |
echo "version=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
echo "tag=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
- name: Create release and upload assets
- name: Create versioned release and upload assets
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: |
VERSION="${{ steps.version.outputs.version }}"
TAG="${GITHUB_REF#refs/tags/}"
TAG="${{ steps.version.outputs.tag }}"
REPO="${GITHUB_REPOSITORY}"
SERVER_URL="${GITHUB_SERVER_URL}"
API_URL="${SERVER_URL}/api/v1"
API_URL="${GITHUB_SERVER_URL}/api/v1"
# Create the release
# Create the versioned release
RELEASE=$(curl -s -X POST "${API_URL}/repos/${REPO}/releases" \
-H "Authorization: token ${GITEA_TOKEN}" \
-H "Content-Type: application/json" \
@@ -60,7 +64,7 @@ jobs:
echo "Created release ID: ${RELEASE_ID}"
# Upload all XPI files
# Upload XPI
for XPI in .scaffold/build/*.xpi; do
[ -f "${XPI}" ] || continue
FILENAME=$(basename "${XPI}")
@@ -71,7 +75,7 @@ jobs:
--data-binary "@${XPI}"
done
# Upload update manifests if present
# Upload update manifests
for JSON in .scaffold/build/update.json .scaffold/build/update-beta.json; do
[ -f "${JSON}" ] || continue
FILENAME=$(basename "${JSON}")
@@ -82,4 +86,103 @@ jobs:
--data-binary "@${JSON}"
done
echo "Release ${TAG} published successfully."
echo "Versioned release ${TAG} published."
- name: Upload build artifacts for next job
uses: actions/upload-artifact@v4
with:
name: build-output
path: .scaffold/build/
retention-days: 1
update-rolling-release:
runs-on: ubuntu-latest
needs: build
steps:
- name: Download build artifacts
uses: actions/download-artifact@v4
with:
name: build-output
path: .scaffold/build/
- name: Upsert rolling 'release' tag with latest update.json
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: |
TAG="release"
REPO="${GITHUB_REPOSITORY}"
API_URL="${GITHUB_SERVER_URL}/api/v1"
VERSION="${{ needs.build.outputs.version }}"
# Check if the rolling release already exists
EXISTING=$(curl -s -o /dev/null -w "%{http_code}" \
"${API_URL}/repos/${REPO}/releases/tags/${TAG}" \
-H "Authorization: token ${GITEA_TOKEN}")
if [ "${EXISTING}" = "200" ]; then
# Fetch the release ID
RELEASE_ID=$(curl -s "${API_URL}/repos/${REPO}/releases/tags/${TAG}" \
-H "Authorization: token ${GITEA_TOKEN}" \
| grep -o '"id":[0-9]*' | head -1 | cut -d: -f2)
echo "Found existing 'release' release (ID: ${RELEASE_ID}). Replacing assets..."
# Delete all existing assets so we can upload fresh ones
ASSETS=$(curl -s "${API_URL}/repos/${REPO}/releases/${RELEASE_ID}/assets" \
-H "Authorization: token ${GITEA_TOKEN}")
echo "${ASSETS}" | grep -o '"id":[0-9]*' | cut -d: -f2 | while read ASSET_ID; do
echo "Deleting asset ${ASSET_ID}..."
curl -s -X DELETE "${API_URL}/repos/${REPO}/releases/${RELEASE_ID}/assets/${ASSET_ID}" \
-H "Authorization: token ${GITEA_TOKEN}"
done
# Update the release body to reflect the current version
curl -s -X PATCH "${API_URL}/repos/${REPO}/releases/${RELEASE_ID}" \
-H "Authorization: token ${GITEA_TOKEN}" \
-H "Content-Type: application/json" \
-d "{\"body\": \"Rolling release — always points to the latest update manifest (currently v${VERSION}). Do not delete.\"}"
else
# Create the rolling release for the first time
echo "Creating new 'release' release..."
# Ensure the tag exists (Gitea requires the tag to exist before creating a release for it)
curl -s -X POST "${API_URL}/repos/${REPO}/tags" \
-H "Authorization: token ${GITEA_TOKEN}" \
-H "Content-Type: application/json" \
-d "{\"tag_name\": \"${TAG}\", \"message\": \"Rolling release tag for update.json hosting\"}" || true
RELEASE=$(curl -s -X POST "${API_URL}/repos/${REPO}/releases" \
-H "Authorization: token ${GITEA_TOKEN}" \
-H "Content-Type: application/json" \
-d "{
\"tag_name\": \"${TAG}\",
\"name\": \"Update Manifest (rolling)\",
\"body\": \"Rolling release — always points to the latest update manifest (currently v${VERSION}). Do not delete.\",
\"draft\": false,
\"prerelease\": false
}")
RELEASE_ID=$(echo "${RELEASE}" | grep -o '"id":[0-9]*' | head -1 | cut -d: -f2)
if [ -z "${RELEASE_ID}" ]; then
echo "Failed to create rolling release. Response: ${RELEASE}"
exit 1
fi
echo "Created rolling release ID: ${RELEASE_ID}"
fi
# Upload update.json and update-beta.json to the rolling release
for JSON in .scaffold/build/update.json .scaffold/build/update-beta.json; do
[ -f "${JSON}" ] || continue
FILENAME=$(basename "${JSON}")
echo "Uploading ${FILENAME} to rolling release..."
curl -s -X POST "${API_URL}/repos/${REPO}/releases/${RELEASE_ID}/assets?name=${FILENAME}" \
-H "Authorization: token ${GITEA_TOKEN}" \
-H "Content-Type: application/json" \
--data-binary "@${JSON}"
done
echo "Rolling 'release' release updated to v${VERSION}."

View File

@@ -17,7 +17,8 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"format": "prettier --write \"src/**/*.ts\" \"addon/**/*.js\"",
"format:check": "prettier --check \"src/**/*.ts\" \"addon/**/*.js\""
"format:check": "prettier --check \"src/**/*.ts\" \"addon/**/*.js\"",
"postinstall": "node scripts/patch-scaffold.mjs"
},
"repository": {
"type": "git",

View File

@@ -0,0 +1,45 @@
/**
* Patches zotero-plugin-scaffold's parseRepoUrl to accept non-.com domains.
*
* The upstream regex hardcodes `.com` in the URL pattern, which breaks builds
* when the repository is hosted on a self-hosted Gitea instance (any other TLD).
* This script runs automatically via the `postinstall` npm hook after every
* `npm install` / `npm ci`.
*/
import { readFileSync, writeFileSync } from "fs";
import { resolve, dirname } from "path";
import { fileURLToPath } from "url";
const __dirname = dirname(fileURLToPath(import.meta.url));
const target = resolve(
__dirname,
"../node_modules/zotero-plugin-scaffold/dist/shared/zotero-plugin-scaffold.Lk5EW_9z.mjs"
);
let content;
try {
content = readFileSync(target, "utf8");
} catch {
console.warn("[patch-scaffold] Target file not found, skipping patch.");
process.exit(0);
}
// Original: matches only .com hosts
// /:\/\/.+com\/([^/]+)\/([^.]+)\.git$/
// Replacement: matches any host and makes .git suffix optional
// /:\/\/.+?\/([^/]+)\/([^/.]+)(?:\.git)?$/
const SEARCH = String.raw`url.match(/:\/\/.+com\/([^/]+)\/([^.]+)\.git$/)`;
const REPLACE = String.raw`url.match(/:\/\/.+?\/([^/]+)\/([^/.]+)(?:\.git)?$/)`;
if (content.includes(SEARCH)) {
writeFileSync(target, content.replace(SEARCH, REPLACE), "utf8");
console.log("[patch-scaffold] Applied: parseRepoUrl now accepts any TLD.");
} else if (content.includes(REPLACE)) {
console.log("[patch-scaffold] Already patched, nothing to do.");
} else {
console.warn(
"[patch-scaffold] Could not find target string — scaffold may have been updated. " +
"Check scripts/patch-scaffold.mjs and update SEARCH/REPLACE strings."
);
}

View File

@@ -1,12 +1,18 @@
import { defineConfig } from "zotero-plugin-scaffold";
import pkg from "./package.json";
const GITEA_BASE = "https://gitea.bueso.eu/ignacio.ballesteros/zotero-notes-export-org";
export default defineConfig({
source: ["src", "addon"],
dist: ".scaffold/build",
name: pkg.config.addonName,
id: pkg.config.addonID,
namespace: pkg.config.addonRef,
// Explicit URLs are required because zotero-plugin-scaffold's URL parser
// only handles .com domains and cannot parse our self-hosted Gitea instance.
xpiDownloadLink: `${GITEA_BASE}/releases/download/v{{version}}/{{xpiName}}.xpi`,
updateURL: `${GITEA_BASE}/releases/download/release/{{updateJson}}`,
build: {
esbuildOptions: [
{