@goreleaser/sponsors 0.0.1 → 0.2.1

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 GoReleaser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,99 @@
+# sponsors
+
+Fetches sponsors from [GitHub Sponsors](https://github.com/sponsors) and [OpenCollective](https://opencollective.com) and renders them into your files via Go templates.
+
+## Install
+
+```sh
+# brew:
+brew install --cask goreleaser/tap/sponsors
+
+# npm/npx:
+npm -ig @goreleaser/sponsors
+npx @goreleaser/sponsors
+
+# from source:
+go install github.com/goreleaser/sponsors@latest
+```
+
+## Usage
+
+```sh
+# Fetch sponsors and write sponsors.json (requires GITHUB_TOKEN)
+sponsors generate --config sponsors.yml sponsors.json
+
+# Render a template between commented markers (sponsors apply --help):
+sponsors apply sponsors.json readme.tpl.md README.md
+```
+
+`--config` defaults to `sponsors.yml` in the current directory.
+
+## Config
+
+```yaml
+github_user: caarlos0
+opencollective_slug: goreleaser
+
+tiers:
+  - id: gold
+    name: Gold
+    monthly_rate: 100
+  - id: backer
+    name: Backer
+    monthly_rate: 0
+
+# Redirect a sponsor's login to another account (e.g. individual → org).
+# The target's real name, avatar and website are fetched from GitHub.
+aliases:
+  johndoe: acme-corp
+
+# Manually managed entries; those past end_date are silently ignored.
+external_sponsors:
+  - name: Acme Corp
+    id: acme-corp
+    source: github
+    website: https://acme.com
+    image: https://github.com/acme-corp.png
+    tier: gold
+    end_date: "2027-03-23"
+```
+
+## Templates
+
+Templates receive `.Sponsors`, `.Tiers`, and `.ByTier` (sponsors keyed by tier ID).
+A `dict` helper and `Sponsor.LogoWithSize(size int)` are available:
+
+```go-template
+{{- define "tier" -}}
+{{- if $s := index . "sponsors" }}
+{{- range $s }}<a href="{{ .Website }}"><img src="{{ .LogoWithSize (index $ "size") }}" /></a>{{ end }}
+{{- end -}}
+{{- end -}}
+{{- template "tier" (dict "size" 96 "sponsors" (index .ByTier "gold")) -}}
+```
+
+---
+
+<!-- sponsors:begin -->
+<!-- this list is auto-generated by https://github.com/goreleaser/sponsors -->
+<div align="center">
+  <h2>Our Sponsors</h2>
+  <h3>Platinum</h3>
+  <a href="https://github.com/SAP" target="_blank" rel="noopener sponsored" ><img src="https://avatars.githubusercontent.com/u/2531208?v=4&s=112" alt="SAP" width="112" height="112"/></a>
+  <h3>Gold</h3>
+  <a href="https://github.com/mercedes-benz" target="_blank" rel="noopener sponsored" ><img src="https://avatars.githubusercontent.com/u/34240465?v=4&s=96" alt="Mercedes-Benz Group" width="96" height="96"/></a>
+  <a href="https://github.com/nitrictech" target="_blank" rel="noopener sponsored" ><img src="https://avatars.githubusercontent.com/u/72055470?v=4&s=96" alt="nitric" width="96" height="96"/></a>
+  <h3>Silver</h3>
+  <a href="https://depot.dev" target="_blank" rel="noopener sponsored" ><img src="https://images.opencollective.com/depot/39125a1/logo.png?height=80" alt="Depot" width="80" height="80"/></a>
+  <a href="https://www.n-ix.com/" target="_blank" rel="noopener sponsored" ><img src="https://images.opencollective.com/n-ix-ltd/575a7a5/logo.png?height=80" alt="N-iX Ltd" width="80" height="80"/></a>
+  <h3>Bronze</h3>
+  <a href="https://github.com/conetcloud" target="_blank" rel="noopener sponsored" ><img src="https://avatars.githubusercontent.com/u/35725664?v=4&s=64" alt="conet cloud" width="64" height="64"/></a>
+  <a href="https://github.com/encoredev" target="_blank" rel="noopener sponsored" ><img src="https://avatars.githubusercontent.com/u/50438175?v=4&s=64" alt="Encore" width="64" height="64"/></a>
+  <a href="https://github.com/comet-ml" target="_blank" rel="noopener sponsored" ><img src="https://avatars.githubusercontent.com/u/31487821?v=4&s=64" alt="Comet" width="64" height="64"/></a>
+  <a href="https://about.gitea.com/" target="_blank" rel="noopener sponsored" ><img src="https://images.opencollective.com/gitea/bf35c2f/logo.png?height=64" alt="Gitea" width="64" height="64"/></a>
+  <a href="www.interviewpal.com" target="_blank" rel="noopener sponsored" ><img src="https://avatars.githubusercontent.com/u/268665632?v=4&s=64" alt="InterviewPal.com" width="64" height="64"/></a>
+  <h3>And many more!</h3>
+  <p>See the full list <a href="https://goreleaser.com/sponsors" target="_blank" rel="noopener sponsored">here</a>.</p>
+</div>
+
+<!-- sponsors:end -->

package/install.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+// This file was generated by GoReleaser. DO NOT EDIT.
+
+import { install } from "./lib.js";
+install();

package/lib.js

@@ -0,0 +1,229 @@
+// This file was generated by GoReleaser. DO NOT EDIT.
+import fs from "fs";
+import crypto from "crypto";
+import path from "path";
+import JSZip from "jszip";
+import { x as tarExtract } from "tar";
+import axios from "axios";
+import { ProxyAgent } from "proxy-agent";
+import { spawnSync } from "child_process";
+import { fileURLToPath } from "url";
+
+const { archives, name, version } = JSON.parse(
+	fs.readFileSync(new URL("./package.json", import.meta.url), "utf8"),
+);
+
+const agent = new ProxyAgent();
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+const getArchive = () => {
+	let target = `${process.platform}-${process.arch}`;
+	const archive = archives[target];
+	if (!archive) {
+		throw new Error(`No archive available for ${target}`);
+	}
+	return archive;
+};
+
+const binDir = path.join(__dirname, "bin");
+
+async function extractTar(tarPath, binaries, dir, wrappedIn) {
+	try {
+		const filesToExtract = wrappedIn
+			? binaries.map((bin) =>
+				path.join(wrappedIn, bin).replace(/\\/g, "/"),
+			)
+			: binaries;
+
+		await tarExtract({
+			file: tarPath,
+			cwd: dir,
+			filter: (path) => filesToExtract.includes(path),
+		});
+
+		// If wrapped, move files from wrapped directory to bin directory
+		if (wrappedIn) {
+			const wrappedDir = path.join(dir, wrappedIn);
+			for (const binary of binaries) {
+				const srcPath = path.join(wrappedDir, binary);
+				const destPath = path.join(dir, binary);
+				if (fs.existsSync(srcPath)) {
+					fs.renameSync(srcPath, destPath);
+				}
+			}
+			// Clean up empty wrapped directory
+			try {
+				fs.rmSync(wrappedDir, { recursive: true, force: true });
+			} catch (err) {
+				// Ignore cleanup errors
+			}
+		}
+
+		console.log(`Successfully extracted ${binaries} to "${dir}"`);
+	} catch (err) {
+		throw new Error(`Extraction failed: ${err.message}`);
+	}
+}
+
+async function extractZip(zipPath, binaries, dir, wrappedIn) {
+	try {
+		const zipData = fs.readFileSync(zipPath);
+		const zip = await JSZip.loadAsync(zipData);
+
+		for (const binary of binaries) {
+			const binaryPath = wrappedIn
+				? path.join(wrappedIn, binary).replace(/\\/g, "/")
+				: binary;
+
+			if (!zip.files[binaryPath]) {
+				throw new Error(
+					`Error: ${binaryPath} does not exist in ${zipPath}`,
+				);
+			}
+
+			const content = await zip.files[binaryPath].async("nodebuffer");
+			if (!fs.existsSync(dir)) {
+				fs.mkdirSync(dir, { recursive: true });
+			}
+			const file = path.join(dir, binary);
+			fs.writeFileSync(file, content);
+			fs.chmodSync(file, "755");
+			console.log(`Successfully extracted "${binary}" to "${dir}"`);
+		}
+	} catch (err) {
+		throw new Error(`Extraction failed: ${err.message}`);
+	}
+}
+
+const run = async (bin) => {
+	await install();
+	if (process.platform === "win32") {
+		bin += ".exe";
+	}
+	const [, , ...args] = process.argv;
+	let result = spawnSync(path.join(binDir, bin), args, {
+		cwd: process.cwd(),
+		stdio: "inherit",
+	});
+	if (result.error) {
+		console.error(result.error);
+	}
+	return result.status;
+};
+
+const install = async () => {
+	try {
+		let archive = getArchive();
+		if (await exists(archive)) {
+			return;
+		}
+		let tmp = fs.mkdtempSync("archive-");
+		let archivePath = path.join(tmp, archive.name);
+		await download(archive.url, archivePath);
+		verify(archivePath, archive.checksum);
+
+		if (!fs.existsSync(binDir)) {
+			fs.mkdirSync(binDir);
+		}
+		switch (archive.format) {
+			case "binary":
+				const bin = path.join(binDir, archive.bins[0]);
+				fs.copyFileSync(archivePath, bin);
+				fs.chmodSync(bin, 0o755);
+				break;
+			case "zip":
+				await extractZip(
+					archivePath,
+					archive.bins,
+					binDir,
+					archive.wrappedIn,
+				);
+				break;
+			case "tar":
+			case "tar.gz":
+			case "tgz":
+				await extractTar(
+					archivePath,
+					archive.bins,
+					binDir,
+					archive.wrappedIn,
+				);
+				break;
+			case "tar.zst":
+			case "tzst":
+			case "tar.xz":
+			case "txz":
+			default:
+				throw new Error(`unsupported format: ${archive.format}`);
+		}
+		console.log(`Installed ${name} ${version} to ${binDir}`);
+	} catch (err) {
+		throw new Error(`Installation failed: ${err.message}`);
+	}
+};
+
+const verify = (filename, checksum) => {
+	if (checksum.algorithm == "" || checksum.digest == "") {
+		console.warn("Warning: No checksum provided for verification");
+		return;
+	}
+	let digest = crypto
+		.createHash(checksum.algorithm)
+		.update(fs.readFileSync(filename))
+		.digest("hex");
+	if (digest != checksum.digest) {
+		throw new Error(
+			`${filename}: ${checksum.algorithm} does not match, expected ${checksum.digest}, got ${digest}`,
+		);
+	}
+};
+
+const download = async (url, filename) => {
+	try {
+		console.log(`Downloading ${url} to ${filename}...`);
+		const dir = path.dirname(filename);
+		if (!fs.existsSync(dir)) {
+			fs.mkdirSync(dir, { recursive: true });
+		}
+
+		const response = await axios({
+			method: "GET",
+			url: url,
+			responseType: "stream",
+			timeout: 300000, // 5min
+			httpAgent: agent,
+			httpsAgent: agent,
+		});
+
+		const writer = fs.createWriteStream(filename);
+		response.data.pipe(writer);
+
+		return new Promise((resolve, reject) => {
+			writer.on("finish", () => {
+				console.log(`Download complete: ${filename}`);
+				resolve(dir);
+			});
+
+			writer.on("error", (err) => {
+				console.error(`Error writing file: ${err.message}`);
+				reject(err);
+			});
+		});
+	} catch (err) {
+		throw new Error(`Download failed: ${err.message}`);
+	}
+};
+
+function exists(archive) {
+	if (!fs.existsSync(binDir)) {
+		return false;
+	}
+	return archive.bins.every((bin) => fs.existsSync(path.join(binDir, bin)));
+}
+
+export {
+	install,
+	run,
+	getArchive,
+	download,
+};

package/package.json

@@ -1,12 +1,113 @@
 {
   "name": "@goreleaser/sponsors",
-  "version": "0.0.1",
-  "description": "",
-  "license": "MIT",
-  "author": "",
-  "type": "commonjs",
-  "main": "index.js",
+  "type": "module",
+  "version": "0.2.1",
+  "description": "Fetches sponsors from multiple sources and renders them based on templates",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "postinstall": "node install.js",
+    "run": "node run-sponsors.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/goreleaser/sponsors"
+  },
+  "keywords": [
+    "goreleaser",
+    "sponsors"
+  ],
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/goreleaser/mcp/sponsors"
+  },
+  "homepage": "https://goreleaser.com/sponsors",
+  "bin": {
+    "sponsors": "run-sponsors.js"
+  },
+  "dependencies": {
+    "axios": "^1.8.2",
+    "jszip": "^3.10.1",
+    "proxy-agent": "^7.0.0",
+    "tar": "^7.4.3"
+  },
+  "archives": {
+    "darwin-arm64": {
+      "name": "sponsors_darwin_arm64.tar.gz",
+      "url": "https://github.com/goreleaser/sponsors/releases/download/v0.2.1/sponsors_darwin_arm64.tar.gz",
+      "bins": [
+        "sponsors"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "627a85ab5d3fa3f12adc2c04526bb174df78eaf3a15a895b5c22b7a92184dc5a"
+      },
+      "wrappedIn": "sponsors_darwin_arm64"
+    },
+    "darwin-x64": {
+      "name": "sponsors_darwin_amd64.tar.gz",
+      "url": "https://github.com/goreleaser/sponsors/releases/download/v0.2.1/sponsors_darwin_amd64.tar.gz",
+      "bins": [
+        "sponsors"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "7df34dd32f3fcdeca14eb43252a5a93b35b0e3e93a546c894c9f8bc5e0186c74"
+      },
+      "wrappedIn": "sponsors_darwin_amd64"
+    },
+    "linux-arm64": {
+      "name": "sponsors_linux_arm64.tar.gz",
+      "url": "https://github.com/goreleaser/sponsors/releases/download/v0.2.1/sponsors_linux_arm64.tar.gz",
+      "bins": [
+        "sponsors"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "a2a56990067be36dd6342a0896048395f107858ba5bf725996e3d581137534ae"
+      },
+      "wrappedIn": "sponsors_linux_arm64"
+    },
+    "linux-x64": {
+      "name": "sponsors_linux_amd64.tar.gz",
+      "url": "https://github.com/goreleaser/sponsors/releases/download/v0.2.1/sponsors_linux_amd64.tar.gz",
+      "bins": [
+        "sponsors"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "905241b2a3179f0d393072b17b1e966df6ec5bc16ba3be4011e0cfc75631fdbc"
+      },
+      "wrappedIn": "sponsors_linux_amd64"
+    },
+    "win32-arm64": {
+      "name": "sponsors_windows_arm64.tar.gz",
+      "url": "https://github.com/goreleaser/sponsors/releases/download/v0.2.1/sponsors_windows_arm64.tar.gz",
+      "bins": [
+        "sponsors.exe"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "fe4c33d8a9ae927f9c5d49e2368ca86319fde0ebe2574cfbd965b7a7822f0ec7"
+      },
+      "wrappedIn": "sponsors_windows_arm64"
+    },
+    "win32-x64": {
+      "name": "sponsors_windows_amd64.tar.gz",
+      "url": "https://github.com/goreleaser/sponsors/releases/download/v0.2.1/sponsors_windows_amd64.tar.gz",
+      "bins": [
+        "sponsors.exe"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "9cacaaac20c1b113facbf71e369cb5529c1f71ccd25351282c2a7b4071162dc5"
+      },
+      "wrappedIn": "sponsors_windows_amd64"
+    }
   }
-}
+}

package/run-sponsors.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+// This file was generated by GoReleaser. DO NOT EDIT.
+
+import { run } from "./lib.js";
+run("sponsors").then((code) => process.exit(code));